Update api-reference.md

Co-authored-by: elastic-renovate-prod[bot] <174716857+elastic-renovate-prod[bot]@users.noreply.github.com>

.buildkite/Dockerfile

@@ -1,4 +1,4 @@
-ARG NODE_VERSION=${NODE_VERSION:-18}
+ARG NODE_VERSION=${NODE_VERSION:-20}
 FROM node:$NODE_VERSION
 
 # Install required tools
@@ -12,5 +12,3 @@ WORKDIR /usr/src/app
 
 COPY package.json .
 RUN npm install
-
-COPY . .

.buildkite/Dockerfile-make

@@ -1,4 +1,4 @@
-ARG NODE_JS_VERSION=${NODE_JS_VERSION:-18}
+ARG NODE_JS_VERSION=${NODE_JS_VERSION:-20}
 FROM node:${NODE_JS_VERSION}
 
 ARG BUILDER_UID=1000
@@ -25,6 +25,3 @@ USER ${BUILDER_UID}:${BUILDER_GID}
 # install dependencies
 COPY package.json .
 RUN npm install
-
-# copy project files
-COPY . .

.buildkite/make.mjs

@@ -1,20 +1,6 @@
 /*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
  */
 
 /* global $ argv */
@@ -123,7 +109,7 @@ async function codegen (args) {
   await $`rm -rf ${join(import.meta.url, '..', 'src', 'api')}`
   await $`mkdir ${join(import.meta.url, '..', 'src', 'api')}`
   await $`cp -R ${join(import.meta.url, '..', '..', 'elastic-client-generator-js', 'output')}/* ${join(import.meta.url, '..', 'src', 'api')}`
-  await $`mv ${join(import.meta.url, '..', 'src', 'api', 'reference.asciidoc')} ${join(import.meta.url, '..', 'docs', 'reference.asciidoc')}`
+  await $`mv ${join(import.meta.url, '..', 'src', 'api', 'reference.md')} ${join(import.meta.url, '..', 'docs', 'reference', 'api-reference.md')}`
   await $`npm run build`
 
   // run docs example generation

.buildkite/pipeline.yml

@@ -16,16 +16,16 @@ steps:
     matrix:
       setup:
         nodejs:
-          - "18"
           - "20"
           - "22"
+          - "23"
     command: ./.buildkite/run-tests.sh
     artifact_paths: "./junit-output/junit-*.xml"
   - wait: ~
     continue_on_failure: true
   - label: ":junit: Test results"
     plugins:
-      - junit-annotate#v2.4.1:
+      - junit-annotate#v2.6.0:
           artifacts: "junit-output/junit-*.xml"
           job-uuid-file-pattern: "junit-(.*).xml"
           fail-build-on-error: true

.buildkite/run-client.sh

@@ -6,7 +6,7 @@ script_path=$(dirname "$(realpath -s "$0")")
 set -euo pipefail
 repo=$(pwd)
 
-export NODE_VERSION=${NODE_VERSION:-18}
+export NODE_VERSION=${NODE_VERSION:-20}
 
 echo "--- :javascript: Building Docker image"
 docker build \

.github/ISSUE_TEMPLATE/bug.yaml

@@ -40,7 +40,7 @@ body:
     id: node-js-version
     attributes:
       label: Node.js version
-      placeholder: 18.x, 20.x, etc.
+      placeholder: 20.x, 22.x, etc.
     validations:
       required: true
 

.github/stale.yml

@@ -1,26 +0,0 @@
-# Number of days of inactivity before an issue becomes stale
-daysUntilStale: 15
-
-# Number of days of inactivity before a stale issue is closed
-daysUntilClose: 7
-
-# Issues with these labels will never be considered stale
-exemptLabels:
-  - "discussion"
-  - "feature request"
-  - "bug"
-  - "todo"
-  - "good first issue"
-
-# Label to use when marking an issue as stale
-staleLabel: stale
-
-# Comment to post when marking an issue as stale. Set to `false` to disable
-markComment: |
-  We understand that this might be important for you, but this issue has been automatically marked as stale because it has not had recent activity either from our end or yours.
-  It will be closed if no further activity occurs, please write a comment if you would like to keep this going.
-
-  Note: in the past months we have built a new client, that has just landed in master. If you want to open an issue or a pr for the legacy client, you should do that in https://github.com/elastic/elasticsearch-js-legacy
-
-# Comment to post when closing a stale issue. Set to `false` to disable
-closeComment: false

.github/workflows/docs-build.yml

@@ -0,0 +1,19 @@
+name: docs-build
+
+on:
+  push:
+    branches:
+      - main
+  pull_request_target: ~
+  merge_group: ~
+
+jobs:
+  docs-preview:
+    uses: elastic/docs-builder/.github/workflows/preview-build.yml@main
+    with:
+      path-pattern: docs/**
+    permissions:
+      deployments: write
+      id-token: write
+      contents: read
+      pull-requests: read

.github/workflows/docs-cleanup.yml

@@ -0,0 +1,14 @@
+name: docs-cleanup
+
+on:
+  pull_request_target:
+    types:
+      - closed
+
+jobs:
+  docs-preview:
+    uses: elastic/docs-builder/.github/workflows/preview-cleanup.yml@main
+    permissions:
+      contents: none
+      id-token: write
+      deployments: write

.github/workflows/nodejs.yml

@@ -32,7 +32,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [18.x, 20.x, 22.x, 23.x]
+        node-version: [20.x, 22.x, 23.x]
         os: [ubuntu-latest, windows-latest, macOS-latest]
 
     steps:
@@ -41,7 +41,7 @@ jobs:
           persist-credentials: false
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
         with:
           node-version: ${{ matrix.node-version }}
 
@@ -71,7 +71,7 @@ jobs:
           persist-credentials: false
 
       - name: Use Node.js
-        uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
         with:
           node-version: 22.x
 
@@ -83,6 +83,9 @@ jobs:
         run: |
           npm run license-checker
 
+      - name: SPDX header check
+        run: npm run license-header
+
   test-bun:
     name: Test Bun
     runs-on: ${{ matrix.os }}
@@ -101,7 +104,7 @@ jobs:
           persist-credentials: false
 
       - name: Use Bun
-        uses: oven-sh/setup-bun@4bc047ad259df6fc24a6c9b0f9a0cb08cf17fbe5 # v2
+        uses: oven-sh/setup-bun@735343b667d3e6f658f44d0eca948eb6282f2b76 # v2
 
       - name: Install
         run: |

.github/workflows/npm-publish.yml

@@ -16,23 +16,56 @@ jobs:
         with:
           persist-credentials: false
           ref: ${{ github.event.inputs.branch }}
-      - uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4
+      - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
         with:
           node-version: "22.x"
           registry-url: "https://registry.npmjs.org"
       - run: npm install -g npm
       - run: npm install
       - run: npm test
-      - run: npm publish --provenance --access public
+      - name: npm publish
+        run: |
+          version=$(jq -r .version package.json)
+          tag_meta=$(echo "$version" | cut -s -d '-' -f2)
+          # if no meta info on the version (e.g. a '-alpha.1' prefix), publish as a stable release
+          if [[ -z "$tag_meta" ]]; then
+            # get latest version on npm
+            latest=$(npm view @elastic/elasticsearch --json | jq -r '.["dist-tags"].latest')
+
+            # if $version is higher than the most recently published version, publish as-is
+            if [[ $(yes | npx semver "$version" "$latest" | tail -n1) == "$version" ]]; then
+              npm publish --provenance --access public
+            else
+              # otherwise, publish with "previous" tag
+              npm publish --provenance --access public --tag "previous"
+            fi
+          else
+            # publish as a non-stable release using the meta name (e.g. 'alpha') as the tag
+            tag=$(echo "$tag_meta" | cut -d '.' -f1)
+            npm publish --provenance --access public --tag "$tag"
+          fi
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-      - run: |
+      - name: Publish version on GitHub
+        run: |
           version=$(jq -r .version package.json)
-          gh release create \
-            -n "[Changelog](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/$BRANCH_NAME/changelog-client.html)" \
-            --target "$BRANCH_NAME" \
-            -t "v$version" \
-            "v$version"
+          tag_meta=$(echo "$version" | cut -s -d '-' -f2)
+          if [[ -z "$tag_meta" ]]; then
+            gh release create \
+              -n "[Changelog](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/$BRANCH_NAME/changelog-client.html)"
+              --target "$BRANCH_NAME" \
+              --title "v$version" \
+              "v$version"
+          else
+            tag_main=$(echo "$version" | cut -d '-' -f1)
+            gh release create \
+              -n "This is a $tag_main pre-release. Changes may not be stable." \
+              --latest=false \
+              --prerelease \
+              --target "$BRANCH_NAME" \
+              --title "v$version" \
+              "v$version"
+          fi
         env:
           BRANCH_NAME: ${{ github.event.inputs.branch }}
           GH_TOKEN: ${{ github.token }}

.github/workflows/serverless-patch.sh

@@ -1,43 +0,0 @@
-#!/usr/bin/env bash
-
-set -exuo pipefail
-
-merge_commit_sha=$(jq -r '.pull_request.merge_commit_sha' "$GITHUB_EVENT_PATH")
-pull_request_id=$(jq -r '.pull_request.number' "$GITHUB_EVENT_PATH")
-pr_shortcode="elastic/elasticsearch-js#$pull_request_id"
-
-# generate patch file
-cd "$GITHUB_WORKSPACE/stack"
-git format-patch -1 --stdout "$merge_commit_sha" > /tmp/patch.diff
-
-# set committer info
-git config --global user.email "elasticmachine@users.noreply.github.com"
-git config --global user.name "Elastic Machine"
-
-# apply patch file
-cd "$GITHUB_WORKSPACE/serverless"
-git am -C1 --reject /tmp/patch.diff || git am --quit
-
-# generate PR body comment
-comment="Patch applied from $pr_shortcode"
-
-# enumerate rejected patches in PR comment
-has_rejects='false'
-for f in ./**/*.rej; do
-  has_rejects='true'
-  comment="$comment
-
-## Rejected patch \`$f\` must be resolved:
-
-\`\`\`diff
-$(cat "$f")
-\`\`\`
-"
-done
-
-# delete .rej files
-rm -fv ./**/*.rej
-
-# send data to output parameters
-echo "$comment" > /tmp/pr_body
-echo "PR_DRAFT=$has_rejects" >> "$GITHUB_OUTPUT"

.github/workflows/serverless-patch.yml

@@ -1,53 +0,0 @@
----
-name: Apply PR changes to serverless
-on:
-  pull_request_target:
-    types:
-      - closed
-      - labeled
-
-jobs:
-  apply-patch:
-    name: Apply patch
-    runs-on: ubuntu-latest
-    # Only react to merged PRs for security reasons.
-    # See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target.
-    if: >
-      github.event.pull_request.merged
-      && (
-        (
-          github.event.action == 'closed'
-          && contains(github.event.pull_request.labels.*.name, 'apply-to-serverless')
-        )
-        ||
-        (
-          github.event.action == 'labeled'
-          && github.event.label.name == 'apply-to-serverless'
-        )
-      )
-    steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
-        with:
-          persist-credentials: false
-          repository: elastic/elasticsearch-js
-          ref: main
-          path: stack
-          fetch-depth: 0
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
-        with:
-          persist-credentials: false
-          repository: elastic/elasticsearch-serverless-js
-          ref: main
-          path: serverless
-      - name: Apply patch from stack to serverless
-        id: apply-patch
-        run: $GITHUB_WORKSPACE/stack/.github/workflows/serverless-patch.sh
-      - uses: peter-evans/create-pull-request@c5a7806660adbe173f04e3e038b0ccdcd758773c # v6
-        with:
-          token: ${{ secrets.GH_TOKEN }}
-          path: serverless
-          title: "Apply patch from elastic/elasticsearch-js#${{ github.event.pull_request.number }}"
-          commit-message: "Apply patch from elastic/elasticsearch-js#${{ github.event.pull_request.number }}"
-          body-path: /tmp/pr_body
-          draft: "${{ steps.apply-patch.outputs.PR_DRAFT }}"
-          add-paths: ":!*.rej"

.github/workflows/stale.yml

@@ -1,21 +1,21 @@
 ---
-name: 'Close stale issues and PRs'
+name: "Close stale issues and PRs"
 on:
   schedule:
-    - cron: '30 1 * * *'
+    - cron: "30 1 * * *"
 
 jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@1160a2240286f5da8ec72b1c0816ce2481aabf84 # v8
+      - uses: actions/stale@5bef64f19d7facfb25b37b414482c7164d639639 # v9
         with:
           stale-issue-label: stale
           stale-pr-label: stale
           days-before-stale: 90
           days-before-close: 14
-          exempt-issue-labels: 'good first issue'
+          exempt-issue-labels: "good first issue,tracking"
           close-issue-label: closed-stale
           close-pr-label: closed-stale
-          stale-issue-message: 'This issue is stale because it has been open 90 days with no activity. Remove the `stale` label, or leave a comment, or this will be closed in 14 days.'
-          stale-pr-message: 'This pull request is stale because it has been open 90 days with no activity. Remove the `stale` label, or leave a comment, or this will be closed in 14 days.'
+          stale-issue-message: "This issue is stale because it has been open 90 days with no activity. Remove the `stale` label, or leave a comment, or this will be closed in 14 days."
+          stale-pr-message: "This pull request is stale because it has been open 90 days with no activity. Remove the `stale` label, or leave a comment, or this will be closed in 14 days."

README.md

@@ -2,7 +2,7 @@
 
 # Elasticsearch Node.js client
 
-[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)  [![Build Status](https://badge.buildkite.com/15e4246eb268ea78f6e10aa90bce38c1abb0a4489e79f5a0ac.svg)](https://buildkite.com/elastic/elasticsearch-javascript-client-integration-tests/builds?branch=main)  [![Node CI](https://github.com/elastic/elasticsearch-js/actions/workflows/nodejs.yml/badge.svg)](https://github.com/elastic/elasticsearch-js/actions/workflows/nodejs.yml)  [![codecov](https://codecov.io/gh/elastic/elasticsearch-js/branch/master/graph/badge.svg)](https://codecov.io/gh/elastic/elasticsearch-js)  [![NPM downloads](https://img.shields.io/npm/dm/@elastic/elasticsearch.svg?style=flat)](https://www.npmjs.com/package/@elastic/elasticsearch)
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/) [![Build Status](https://badge.buildkite.com/15e4246eb268ea78f6e10aa90bce38c1abb0a4489e79f5a0ac.svg)](https://buildkite.com/elastic/elasticsearch-javascript-client-integration-tests/builds?branch=main) [![Node CI](https://github.com/elastic/elasticsearch-js/actions/workflows/nodejs.yml/badge.svg)](https://github.com/elastic/elasticsearch-js/actions/workflows/nodejs.yml) [![codecov](https://codecov.io/gh/elastic/elasticsearch-js/branch/master/graph/badge.svg)](https://codecov.io/gh/elastic/elasticsearch-js) [![NPM downloads](https://img.shields.io/npm/dm/@elastic/elasticsearch.svg?style=flat)](https://www.npmjs.com/package/@elastic/elasticsearch)
 
 **[Download the latest version of Elasticsearch](https://www.elastic.co/downloads/elasticsearch)**
 or
@@ -34,25 +34,26 @@ the new features of the 8.13 version of Elasticsearch, the 8.13 client version
 is required for that. Elasticsearch language clients are only backwards
 compatible with default distributions and without guarantees made.
 
-| Elasticsearch Version | Elasticsearch-JS Branch  | Supported |
-| --------------------- | ------------------------ | --------- |
-| main                  | main                     |           |
-| 8.x                   | 8.x                      | 8.x       |
-| 7.x                   | 7.x                      | 7.17      |
+| Elasticsearch Version | Elasticsearch-JS Branch |
+| --------------------- | ----------------------- |
+| main                  | main                    |
+| 9.x                   | 9.x                     |
+| 8.x                   | 8.x                     |
+| 7.x                   | 7.x                     |
 
 ## Usage
 
-* [Creating an index](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_creating_an_index)
-* [Indexing a document](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_indexing_documents)
-* [Getting documents](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_getting_documents)
-* [Searching documents](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_searching_documents)
-* [Updating documents](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_updating_documents)
-* [Deleting documents](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_deleting_documents)
-* [Deleting an index](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_deleting_an_index)
+- [Creating an index](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_creating_an_index)
+- [Indexing a document](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_indexing_documents)
+- [Getting documents](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_getting_documents)
+- [Searching documents](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_searching_documents)
+- [Updating documents](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_updating_documents)
+- [Deleting documents](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_deleting_documents)
+- [Deleting an index](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_deleting_an_index)
 
 ### Node.js support
 
-NOTE: The minimum supported version of Node.js is `v18`.
+NOTE: The minimum supported version of Node.js is `v20`.
 
 The client versioning follows the Elastic Stack versioning, this means that
 major, minor, and patch releases are done following a precise schedule that
@@ -65,58 +66,43 @@ to support that version for at least another minor release. If you are using the
 with a version of Node.js that will be unsupported soon, you will see a warning
 in your logs (the client will start logging the warning with two minors in advance).
 
-Unless you are **always** using a supported version of Node.js, 
+Unless you are **always** using a supported version of Node.js,
 we recommend defining the client dependency in your
 `package.json` with the `~` instead of `^`. In this way, you will lock the
 dependency on the minor release and not the major. (for example, `~7.10.0` instead
 of `^7.10.0`).
 
-| Node.js Version | Node.js EOL date | End of support         |
-| --------------- |------------------| ---------------------- |
-| `8.x`           | `December 2019`  | `7.11` (early 2021)    |
-| `10.x`          | `April 2021`     | `7.12` (mid 2021)      |
-| `12.x`          | `April 2022`     | `8.2` (early 2022)     |
-| `14.x`          | `April 2023`     | `8.8` (early 2023)     |
-| `16.x`          | `September 2023` | `8.11` (late 2023)     |
-
-### Compatibility
-
-Language clients are forward compatible; meaning that clients support communicating with greater or equal minor versions of Elasticsearch.
-Elasticsearch language clients are only backwards compatible with default distributions and without guarantees made.
-
-| Elasticsearch Version | Client Version |
-| --------------------- |----------------|
-| `8.x`                 | `8.x`          |
-| `7.x`                 | `7.x`          |
-| `6.x`                 | `6.x`          |
-| `5.x`                 | `5.x`          |
-
-To install a specific major of the client, run the following command:
-```
-npm install @elastic/elasticsearch@<major>
-```
+| Node.js Version | Node.js EOL date | End of support      |
+| --------------- | ---------------- | ------------------- |
+| `8.x`           | `December 2019`  | `7.11` (early 2021) |
+| `10.x`          | `April 2021`     | `7.12` (mid 2021)   |
+| `12.x`          | `April 2022`     | `8.2` (early 2022)  |
+| `14.x`          | `April 2023`     | `8.8` (early 2023)  |
+| `16.x`          | `September 2023` | `8.11` (late 2023)  |
+| `18.x`          | `April 2025`     | `9.1` (mid 2025)    |
 
 #### Browser
 
 > [!WARNING]
 > There is no official support for the browser environment. It exposes your Elasticsearch instance to everyone, which could lead to security issues.
-We recommend that you write a lightweight proxy that uses this client instead, you can see a proxy example [here](./docs/examples/proxy).
+> We recommend that you write a lightweight proxy that uses this client instead, you can see a proxy example [here](./docs/examples/proxy).
 
 ## Documentation
 
-* [Introduction](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/introduction.html)
-* [Usage](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-connecting.html#client-usage)
-* [Client configuration](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-configuration.html)
-* [API reference](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html)
-* [Authentication](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-connecting.html#authentication)
-* [Observability](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/observability.html)
-* [Creating a child client](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/child.html)
-* [Client helpers](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-helpers.html)
-* [Typescript support](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/typescript.html)
-* [Testing](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-testing.html)
-* [Examples](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/examples.html)
+- [Introduction](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/introduction.html)
+- [Usage](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-connecting.html#client-usage)
+- [Client configuration](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-configuration.html)
+- [API reference](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html)
+- [Authentication](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-connecting.html#authentication)
+- [Observability](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/observability.html)
+- [Creating a child client](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/child.html)
+- [Client helpers](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-helpers.html)
+- [Typescript support](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/typescript.html)
+- [Testing](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-testing.html)
+- [Examples](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/examples.html)
 
 ## Install multiple versions
+
 If you are using multiple versions of Elasticsearch, you need to use multiple versions of the client. In the past, install multiple versions of the same package was not possible, but with `npm v6.9`, you can do that via aliasing.
 
 The command you must run to install different version of the client is:
@@ -161,7 +147,7 @@ client7.info().then(console.log, console.log)
 ```
 
 Finally, if you want to install the client for the next version of Elasticsearch
-*(the one that lives in Elasticsearch’s main branch)*, you can use the following
+_(the one that lives in Elasticsearch’s main branch)_, you can use the following
 command:
 
 ```sh

catalog-info.yaml

@@ -28,23 +28,16 @@ spec:
     spec:
       repository: elastic/elasticsearch-js
       pipeline_file: .buildkite/pipeline.yml
+      env:
+        ELASTIC_SLACK_NOTIFICATIONS_ENABLED: "true"
+        SLACK_NOTIFICATIONS_CHANNEL: "#devtools-notify-javascript"
       teams:
         devtools-team:
           access_level: MANAGE_BUILD_AND_READ
         everyone:
           access_level: READ_ONLY
       provider_settings:
-        build_pull_requests: false
+        build_pull_requests: true
         build_branches: false
+        separate_pull_request_statuses: true
       cancel_intermediate_builds: true
-      cancel_intermediate_builds_branch_filter: "!main"
-      schedules:
-        main:
-          branch: "main"
-          cronline: "@daily"
-        8_x:
-          branch: "8.x"
-          cronline: "@daily"
-        8_14:
-          branch: "8.16"
-          cronline: "@daily"

docs/basic-config.asciidoc

@@ -1,273 +0,0 @@
-[[basic-config]]
-=== Basic configuration
-
-This page shows you the possible basic configuration options that the clients
-offers.
-
-
-[source,js]
-----
-const { Client } = require('@elastic/elasticsearch')
-
-const client = new Client({
-  cloud: { id: '<cloud-id>' },
-  auth: { apiKey: 'base64EncodedKey' },
-  maxRetries: 5,
-  requestTimeout: 60000,
-  sniffOnStart: true
-})
-----
-
-
-[cols=2*]
-|===
-|`node` or `nodes`
-a|The Elasticsearch endpoint to use. +
-It can be a single string or an array of strings:
-[source,js]
-----
-node: 'http://localhost:9200'
-----
-Or it can be an object (or an array of objects) that represents the node:
-[source,js]
-----
-node: {
-  url: new URL('http://localhost:9200'),
-  tls: 'tls options',
-  agent: 'http agent options',
-  id: 'custom node id',
-  headers: { 'custom': 'headers' }
-  roles: {
-    master: true,
-    data: true,
-    ingest: true,
-    ml: false
-  }
-}
-----
-
-|`auth`
-a|Your authentication data. You can use both basic authentication and
-{ref}/security-api-create-api-key.html[ApiKey]. +
-See <<authentication,Authentication>> for more details. +
-_Default:_ `null`
-
-Basic authentication:
-[source,js]
-----
-auth: {
-  username: 'elastic',
-  password: 'changeme'
-}
-----
-{ref}/security-api-create-api-key.html[ApiKey] authentication:
-[source,js]
-----
-auth: {
-  apiKey: 'base64EncodedKey'
-}
-----
-Bearer authentication, useful for https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-service-token.html[service account tokens]. Be aware that it does not handle automatic token refresh:
-[source,js]
-----
-auth: {
-  bearer: 'token'
-}
-----
-
-
-|`maxRetries`
-|`number` - Max number of retries for each request. +
-_Default:_ `3`
-
-|`requestTimeout`
-|`number` - Max request timeout in milliseconds for each request. +
-_Default:_ `30000`
-
-|`pingTimeout`
-|`number` - Max ping request timeout in milliseconds for each request. +
-_Default:_ `3000`
-
-|`sniffInterval`
-|`number, boolean` - Perform a sniff operation every `n` milliseconds. Sniffing might not be the best solution for you, take a look https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how[here] to know more. +
-_Default:_ `false`
-
-|`sniffOnStart`
-|`boolean` - Perform a sniff once the client is started. Sniffing might not be the best solution for you, take a look https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how[here] to know more. +
-_Default:_ `false`
-
-|`sniffEndpoint`
-|`string` - Endpoint to ping during a sniff. +
-_Default:_ `'_nodes/_all/http'`
-
-|`sniffOnConnectionFault`
-|`boolean` - Perform a sniff on connection fault. Sniffing might not be the best solution for you, take a look https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how[here] to know more. +
-_Default:_ `false`
-
-|`resurrectStrategy`
-|`string` - Configure the node resurrection strategy. +
-_Options:_ `'ping'`, `'optimistic'`, `'none'` +
-_Default:_ `'ping'`
-
-|`suggestCompression`
-|`boolean` - Adds `accept-encoding` header to every request. +
-_Default:_ `false`
-
-|`compression`
-|`string, boolean` - Enables gzip request body compression. +
-_Options:_ `'gzip'`, `false` +
-_Default:_ `false`
-
-|`tls`
-|`http.SecureContextOptions` - tls https://nodejs.org/api/tls.html[configuraton]. +
-_Default:_ `null`
-
-|`proxy`
-a|`string, URL` - If you are using an http(s) proxy, you can put its url here.
-The client will automatically handle the connection to it. +
-_Default:_ `null`
-[source,js]
-----
-const client = new Client({
-  node: 'http://localhost:9200',
-  proxy: 'http://localhost:8080'
-})
-
-// Proxy with basic authentication
-const client = new Client({
-  node: 'http://localhost:9200',
-  proxy: 'http://user:pwd@localhost:8080'
-})
-----
-
-|`agent`
-a|`http.AgentOptions, function` - http agent https://nodejs.org/api/http.html#http_new_agent_options[options],
-or a function that returns an actual http agent instance. If you want to disable the http agent use entirely
-(and disable the `keep-alive` feature), set the agent to `false`. +
-_Default:_ `null`
-[source,js]
-----
-const client = new Client({
-  node: 'http://localhost:9200',
-  agent: { agent: 'options' }
-})
-
-const client = new Client({
-  node: 'http://localhost:9200',
-  // the function takes as parameter the option
-  // object passed to the Connection constructor
-  agent: (opts) => new CustomAgent()
-})
-
-const client = new Client({
-  node: 'http://localhost:9200',
-  // Disable agent and keep-alive
-  agent: false
-})
-----
-
-|`nodeFilter`
-a|`function` - Takes a `Connection` and returns `true` if it can be sent a request, otherwise `false`. +
-_Default:_
-[source,js]
-----
-function defaultNodeFilter (conn) {
-  if (conn.roles != null) {
-    if (
-      // avoid master-only nodes
-      conn.roles.master &&
-      !conn.roles.data &&
-      !conn.roles.ingest &&
-      !conn.roles.ml
-    ) return false
-  }
-  return true
-}
-----
-
-|`nodeSelector`
-a|`function` - custom selection strategy. +
-_Options:_ `'round-robin'`, `'random'`, custom function +
-_Default:_ `'round-robin'` +
-_Custom function example:_
-[source,js]
-----
-function nodeSelector (connections) {
-  const index = calculateIndex()
-  return connections[index]
-}
-----
-
-|`generateRequestId`
-a|`function` - function to generate the request id for every request, it takes
-two parameters, the request parameters and options. +
-By default it generates an incremental integer for every request. +
-_Custom function example:_
-[source,js]
-----
-function generateRequestId (params, options) {
-  // your id generation logic
-  // must be syncronous
-  return 'id'
-}
-----
-
-|`name`
-|`string, symbol` - The name to identify the client instance in the events. +
-_Default:_ `elasticsearch-js`
-
-|`opaqueIdPrefix`
-|`string` - A string that will be use to prefix any `X-Opaque-Id` header. +
-See https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/observability.html#_x-opaque-id_support[`X-Opaque-Id` support] for more details. +
-_Default:_ `null`
-
-|`headers`
-|`object` - A set of custom headers to send in every request. +
-_Default:_ `{}`
-
-|`context`
-|`object` - A custom object that you can use for observability in your events.
-It will be merged with the API level context option. +
-_Default:_ `null`
-
-|`enableMetaHeader`
-|`boolean` - If true, adds an header named `'x-elastic-client-meta'`, containing some minimal telemetry data,
-such as the client and platform version. +
-_Default:_ `true`
-
-|`cloud`
-a|`object` - Custom configuration for connecting to
-https://cloud.elastic.co[Elastic Cloud]. See https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/auth-reference.html[Authentication]
-for more details. +
-_Default:_ `null` +
-_Cloud configuration example:_
-[source,js]
-----
-const client = new Client({
-  cloud: {
-    id: '<cloud-id>'
-  },
-  auth: {
-    username: 'elastic',
-    password: 'changeme'
-  }
-})
-----
-
-|`disablePrototypePoisoningProtection`
-|`boolean`, `'proto'`, `'constructor'` - The client can protect you against prototype poisoning attacks. Read https://web.archive.org/web/20200319091159/https://hueniverse.com/square-brackets-are-the-enemy-ff5b9fd8a3e8?gi=184a27ee2a08[this article] to learn more about this security concern. If needed, you can enable prototype poisoning protection entirely (`false`) or one of the two checks (`'proto'` or `'constructor'`). For performance reasons, it is disabled by default. Read the `secure-json-parse` https://github.com/fastify/secure-json-parse[documentation] to learn more. +
-_Default:_ `true`
-
-|`caFingerprint`
-|`string` - If configured, verify that the fingerprint of the CA certificate that has signed the certificate of the server matches the supplied fingerprint. Only accepts SHA256 digest fingerprints. +
-_Default:_ `null`
-
-|`maxResponseSize`
-|`number` - When configured, it verifies that the uncompressed response size is lower than the configured number, if it's higher it will abort the request. It cannot be higher than buffer.constants.MAX_STRING_LENGTH +
-_Default:_ `null`
-
-|`maxCompressedResponseSize`
-|`number` - When configured, it verifies that the compressed response size is lower than the configured number, if it's higher it will abort the request. It cannot be higher than buffer.constants.MAX_LENGTH +
-_Default:_ `null`
-
-|===

docs/changelog.asciidoc

@@ -1,959 +0,0 @@
-[[changelog-client]]
-== Release notes
-
-[discrete]
-=== 8.18.2
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Ensure Apache Arrow ES|QL helper uses async iterator
-
-The `esql.toArrowReader()` helper function was trying to return `RecordBatchStreamReader`, a synchronous iterator, despite the fact that the `apache-arrow` package was, in most cases, automatically coercing it to `AsyncRecordBatchStreamReader`, its asynchronous counterpart. It now is always returned as an async iterator.
-
-[discrete]
-=== 8.18.1
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Fix broken node roles and node filter
-
-The docs note a `nodeFilter` option on the client that will, by default, filter the nodes based on any `roles` values that are set at instantition. At some point, this functionality was partially disabled. This brings the feature back, ensuring that it matches what the documentation has said it does all along.
-
-[discrete]
-=== 8.18.0
-
-[discrete]
-==== Features
-
-[discrete]
-===== Support for Elasticsearch `v8.18`
-
-You can find all the API changes
-https://www.elastic.co/guide/en/elasticsearch/reference/8.18/release-notes-8.18.0.html[here].
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Improved Cloud ID parsing
-
-When using a Cloud ID as the `cloud` parameter to instantiate the client, that ID was assumed to be in the correct format. New assertions have been added to verify that format and throw a `ConfigurationError` if it is invalid. See https://github.com/elastic/elasticsearch-js/issues/2694[#2694].
-
-[discrete]
-=== 8.17.0
-
-[discrete]
-==== Features
-
-[discrete]
-===== Support for Elasticsearch `v8.17`
-
-You can find all the API changes
-https://www.elastic.co/guide/en/elasticsearch/reference/8.17/release-notes-8.17.0.html[here].
-
-[discrete]
-=== 8.16.3
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Improved support for Elasticsearch `v8.16`
-
-Updated TypeScript types based on fixes and improvements to the Elasticsearch specification.
-
-[discrete]
-=== 8.16.2
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Improved support for Elasticsearch `v8.16`
-
-Updated TypeScript types based on fixes and improvements to the Elasticsearch specification.
-
-[discrete]
-===== Drop testing artifacts from npm package
-
-Tap, the unit testing tool used by this project, was recently upgraded and started writing to a `.tap` directory. Since tests are run prior to an `npm publish` in CI, this directory was being included in the published package and bloating its size.
-
-[discrete]
-=== 8.16.1
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Fix ECMAScript imports
-
-Fixed package configuration to correctly support native ECMAScript `import` syntax.
-
-[discrete]
-=== 8.16.0
-
-[discrete]
-==== Features
-
-[discrete]
-===== Support for Elasticsearch `v8.16`
-
-You can find all the API changes
-https://www.elastic.co/guide/en/elasticsearch/reference/8.16/release-notes-8.16.0.html[here].
-
-[discrete]
-===== Support Apache Arrow in ES|QL helper
-
-The ES|QL helper can now return results as an Apache Arrow `Table` or `RecordBatchReader`, which enables high-performance calculations on ES|QL results, even if the response data is larger than the system's available memory. See <<esql-helper>> for more information.
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Pass prototype poisoning options to serializer correctly
-
-The client's `disablePrototypePoisoningProtection` option was set to `true` by default, but when it was set to any other value it was ignored, making it impossible to enable prototype poisoning protection without providing a custom serializer implementation.
-
-[discrete]
-=== 8.15.3
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Improved support for Elasticsearch `v8.15`
-
-Updated TypeScript types based on fixes and improvements to the Elasticsearch specification.
-
-[discrete]
-===== Drop testing artifacts from npm package
-
-Tap, the unit testing tool, was recently upgraded and started writing to a `.tap` directory. Since tests are run prior to an `npm publish` in CI, this directory was being included in the published package and bloating its size.
-
-[discrete]
-=== 8.15.2
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Improved support for Elasticsearch `v8.15`
-
-Updated TypeScript types based on fixes and improvements to the Elasticsearch specification.
-
-[discrete]
-=== 8.15.1
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Improved support for Elasticsearch `v8.15`
-
-Updated TypeScript types based on fixes and improvements to the Elasticsearch specification.
-
-[discrete]
-=== 8.15.0
-
-[discrete]
-==== Features
-
-[discrete]
-===== Support for Elasticsearch `v8.15.0`
-
-You can find all the API changes
-https://www.elastic.co/guide/en/elasticsearch/reference/8.15/release-notes-8.15.0.html[here].
-
-[discrete]
-===== OpenTelemetry zero-code instrumentation support
-
-For those that use an observability service that supports OpenTelemetry spans, the client will now automatically generate traces for each Elasticsearch request it makes.
-See {jsclient}/observability.html#_opentelemetry[the docs]
-for more information.
-
-[discrete]
-=== 8.14.1
-
-[discrete]
-==== Features
-
-[discrete]
-===== Improved support for Elasticsearch `8.14`
-
-Updated types based on fixes and changes to the Elasticsearch specification.
-
-[discrete]
-=== 8.14.0
-
-[discrete]
-==== Features
-
-[discrete]
-===== Support for Elasticsearch `v8.14.0`
-
-You can find all the API changes
-https://www.elastic.co/guide/en/elasticsearch/reference/8.14/release-notes-8.14.0.html[here].
-
-[discrete]
-===== ES|QL object API helper
-
-A helper method has been added that parses the response of an ES|QL query and converts it into an array of objects.
-A TypeScript type parameter can also be provided to improve developer experience when working with the result. https://github.com/elastic/elasticsearch-js/pull/2238[#2238]
-
-[discrete]
-===== `onSuccess` callback added to bulk helper
-
-The bulk helper now supports an `onSuccess` callback that will be called for each successful operation. https://github.com/elastic/elasticsearch-js/pull/2199[#2199]
-
-[discrete]
-===== Request retries are more polite
-
-https://github.com/elastic/elastic-transport-js/releases/tag/v8.6.0[`@elastic/transport` v8.6.0] was released, which refactored when and how failed requests are retried. Timed-out requests are no longer retried by default, and retries now use exponential backoff rather than running immediately.
-
-
-[discrete]
-=== 8.13.1
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Pin @elastic/transport to `~8.4.1`
-
-Switching from `^8.4.1` to `~8.4.1` ensures 8.13 client users are not required to update to Node.js v18+, which is a new requirement set by `@elastic/transport` v8.5.0. See https://github.com/elastic/elastic-transport-js/issues/91[elastic/elastic-transport-js#91] for details.
-
-v8.13.0 was also released depending on v8.4.0 of `@elastic/transport` instead of v8.4.1, which was unintentional.
-
-[discrete]
-=== 8.13.0
-
-[discrete]
-==== Features
-
-[discrete]
-===== Support for Elasticsearch `v8.13.0`
-
-You can find all the API changes
-https://www.elastic.co/guide/en/elasticsearch/reference/8.13/release-notes-8.13.0.html[here].
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Ensure new connections inherit client's set defaults https://github.com/elastic/elasticsearch-js/pull/2159[#2159]
-
-When instantiating a client, any connection-related defaults (e.g. `requestTimeout`) set on that client instance would not be inherited by nodes if they were entered as strings rather than a `ConnectionOptions` object.
-
-[discrete]
-=== 8.12.3
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Bump @elastic/transport to `~8.4.1`
-
-Switching from `^8.4.1` to `~8.4.1` ensures 8.12 client users are not required to update to Node.js v18+, which is a new requirement set by `@elastic/transport` v8.5.0. See https://github.com/elastic/elastic-transport-js/issues/91[elastic/elastic-transport-js#91] for details.
-
-[discrete]
-=== 8.12.2
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Upgrade transport to 8.4.1 https://github.com/elastic/elasticsearch-js/pull/2137[#2137]
-
-Upgrades `@elastic/transport` to 8.4.1 to resolve https://github.com/elastic/elastic-transport-js/pull/83[a bug] where arrays in error diagnostics were unintentionally transformed into objects.
-
-[discrete]
-=== 8.12.1
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Fix hang in bulk helper semaphore https://github.com/elastic/elasticsearch-js/pull/2027[#2027]
-
-The failing state could be reached when a server's response times are slower than flushInterval.
-
-[discrete]
-=== 8.12.0
-
-[discrete]
-=== Features
-
-[discrete]
-===== Support for Elasticsearch `v8.12.0`
-
-You can find all the API changes
-https://www.elastic.co/guide/en/elasticsearch/reference/8.12/release-notes-8.12.0.html[here].
-
-[discrete]
-=== 8.11.1
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Bump @elastic/transport to `~8.4.0`
-
-Switching from `^8.4.0` to `~8.4.0` ensures 8.11 client users are not required to update to Node.js v18+, which is a new requirement set by `@elastic/transport` v8.5.0. See https://github.com/elastic/elastic-transport-js/issues/91[elastic/elastic-transport-js#91] for details.
-
-[discrete]
-=== 8.11.0
-
-[discrete]
-==== Features
-
-[discrete]
-===== Support for Elasticsearch `v8.11.0`
-
-You can find all the API changes
-https://www.elastic.co/guide/en/elasticsearch/reference/8.11/release-notes-8.11.0.html[here].
-
-[discrete]
-===== Enhanced support for redacting potentially sensitive data https://github.com/elastic/elasticsearch-js/pull/2095[#2095]
-
-`@elastic/transport` https://github.com/elastic/elastic-transport-js/releases/tag/v8.4.0[version 8.4.0] introduces enhanced measures for ensuring that request metadata attached to some `Error` objects is redacted. This functionality is primarily to address custom logging solutions that don't use common serialization methods like `JSON.stringify`, `console.log`, or `util.inspect`, which were already accounted for.
-
-See <<redaction>> for more information.
-
-[discrete]
-=== 8.10.1
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Bump @elastic/transport to `~8.3.4`
-
-Switching from `^8.3.4` to `~8.3.4` ensures 8.10 client users are not required to update to Node.js v18+, which is a new requirement set by `@elastic/transport` v8.5.0. See https://github.com/elastic/elastic-transport-js/issues/91[elastic/elastic-transport-js#91] for details.
-
-[discrete]
-=== 8.10.0
-
-[discrete]
-==== Features
-
-[discrete]
-===== Support for Elasticsearch `v8.10.0`
-
-You can find all the API changes
-https://www.elastic.co/guide/en/elasticsearch/reference/8.10/release-notes-8.10.0.html[here].
-
-[discrete]
-=== 8.9.2
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Bump @elastic/transport to `~8.3.4`
-
-Switching from `^8.3.4` to `~8.3.4` ensures 8.9 client users are not required to update to Node.js v18+, which is a new requirement set by `@elastic/transport` v8.5.0. See https://github.com/elastic/elastic-transport-js/issues/91[elastic/elastic-transport-js#91] for details.
-
-[discrete]
-=== 8.9.1
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Upgrade Transport https://github.com/elastic/elasticsearch-js/pull/1968[#1968]
-
-Upgrades `@elastic/transport` to the latest patch release to fix https://github.com/elastic/elastic-transport-js/pull/69[a bug] that could cause the process to exit when handling malformed `HEAD` requests.
-
-[discrete]
-=== 8.9.0
-
-[discrete]
-==== Features
-
-[discrete]
-===== Support for Elasticsearch `v8.9.0`
-
-You can find all the API changes
-https://www.elastic.co/guide/en/elasticsearch/reference/8.9/release-notes-8.9.0.html[here].
-
-[discrete]
-===== Allow document to be overwritten in `onDocument` iteratee of bulk helper https://github.com/elastic/elasticsearch-js/pull/1732[#1732]
-
-In the {jsclient}/client-helpers.html#bulk-helper[bulk helper], documents could not be modified before being sent to Elasticsearch. It is now possible to {jsclient}/client-helpers.html#_modifying_a_document_before_operation[modify a document] before sending it.
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Updated `user-agent` header https://github.com/elastic/elasticsearch-js/pull/1954[#1954]
-
-The `user-agent` header the client used to connect to Elasticsearch was using a non-standard format that has been improved.
-
-[discrete]
-=== 8.8.2
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Bump @elastic/transport to `~8.3.2`
-
-Switching from `^8.3.2` to `~8.3.2` ensures 8.8 client users are not required to update to Node.js v18+, which is a new requirement set by `@elastic/transport` v8.5.0. See https://github.com/elastic/elastic-transport-js/issues/91[elastic/elastic-transport-js#91] for details.
-
-[discrete]
-=== 8.8.1
-
-[discrete]
-==== Features
-
-[discrete]
-===== Support for Elasticsearch `v8.8.1`
-
-You can find all the API changes
-https://www.elastic.co/guide/en/elasticsearch/reference/8.8/release-notes-8.8.1.html[here].
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Fix index drift bug in bulk helper https://github.com/elastic/elasticsearch-js/pull/1759[#1759]
-
-Fixes a bug in the bulk helper that would cause `onDrop` to send back the wrong JSON document or error on a nonexistent document when an error occurred on a bulk HTTP request that contained a `delete` action.
-
-[discrete]
-===== Fix a memory leak caused by an outdated version of Undici https://github.com/elastic/elasticsearch-js/pull/1902[#1902]
-
-Undici 5.5.1, used by https://github.com/elastic/elastic-transport-js[elastic-transport-js], could create a memory leak when a high volume of requests created too many HTTP `abort` listeners. Upgrading Undici to 5.22.1 removed the memory leak.
-
-[discrete]
-=== 8.8.0
-
-[discrete]
-==== Features
-
-[discrete]
-===== Support for Elasticsearch `v8.8.0`
-
-You can find all the API changes
-https://www.elastic.co/guide/en/elasticsearch/reference/8.8/release-notes-8.8.0.html[here].
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Fix type declarations for legacy types with a body key https://github.com/elastic/elasticsearch-js/pull/1784[#1784]
-
-Prior releases contained a bug where type declarations for legacy types that include a `body` key were not actually importing the type that includes the `body` key.
-
-[discrete]
-=== 8.7.3
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Bump @elastic/transport to `~8.3.1`
-
-Switching from `^8.3.1` to `~8.3.1` ensures 8.7 client users are not required to update to Node.js v18+, which is a new requirement set by `@elastic/transport` v8.5.0. See https://github.com/elastic/elastic-transport-js/issues/91[elastic/elastic-transport-js#91] for details.
-
-[discrete]
-=== 8.7.0
-
-[discrete]
-===== Support for Elasticsearch `v8.7.0`
-
-You can find all the API changes
-https://www.elastic.co/guide/en/elasticsearch/reference/8.7/release-notes-8.7.0.html[here].
-
-[discrete]
-=== 8.6.1
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Bump @elastic/transport to `~8.3.1`
-
-Switching from `^8.3.1` to `~8.3.1` ensures 8.6 client users are not required to update to Node.js v18+, which is a new requirement set by `@elastic/transport` v8.5.0. See https://github.com/elastic/elastic-transport-js/issues/91[elastic/elastic-transport-js#91] for details.
-
-[discrete]
-=== 8.6.0
-
-[discrete]
-===== Bump @elastic/transport to 8.3.1+ https://github.com/elastic/elasticsearch-js/pull/1802[#1802]
-
-The `@elastic/transport` dependency has been bumped to `~8.3.1` to ensure
-fixes to the `maxResponseSize` option are available in the client.
-
-[discrete]
-===== Support for Elasticsearch `v8.6.0`
-
-You can find all the API changes
-https://www.elastic.co/guide/en/elasticsearch/reference/8.6/release-notes-8.6.0.html[here].
-
-[discrete]
-=== 8.5.0
-
-[discrete]
-===== Support for Elasticsearch `v8.5.0`
-
-You can find all the API changes
-https://www.elastic.co/guide/en/elasticsearch/reference/8.5/release-notes-8.5.0.html[here].
-
-[discrete]
-=== 8.4.0
-
-[discrete]
-===== Support for Elasticsearch `v8.4.0`
-
-You can find all the API changes
-https://www.elastic.co/guide/en/elasticsearch/reference/8.4/release-notes-8.4.0.html[here].
-
-[discrete]
-=== 8.2.1
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Support for Elasticsearch `v8.2.1`
-
-You can find all the API changes
-https://www.elastic.co/guide/en/elasticsearch/reference/8.2/release-notes-8.2.1.html[here].
-
-[discrete]
-===== Fix ndjson APIs https://github.com/elastic/elasticsearch-js/pull/1688[#1688]
-
-The previous release contained a bug that broken ndjson APIs.
-We have released `v8.2.0-patch.1` to address this.
-This fix is the same as the one we have released and we strongly recommend upgrading to this version.
-
-[discrete]
-===== Fix node shutdown apis https://github.com/elastic/elasticsearch-js/pull/1697[#1697]
-
-The shutdown APIs wheren't complete, this fix completes them.
-
-[discrete]
-==== Types: move query keys to body https://github.com/elastic/elasticsearch-js/pull/1693[#1693]
-
-The types definitions where wrongly representing the types of fields present in both query and body.
-
-[discrete]
-=== 8.2.0
-
-[discrete]
-==== Breaking changes
-
-[discrete]
-===== Drop Node.js v12 https://github.com/elastic/elasticsearch-js/pull/1670[#1670]
-
-According to our https://github.com/elastic/elasticsearch-js#nodejs-support[Node.js support matrix].
-
-[discrete]
-==== Features
-
-[discrete]
-===== Support for Elasticsearch `v8.2`
-
-You can find all the API changes
-https://www.elastic.co/guide/en/elasticsearch/reference/8.2/release-notes-8.2.0.html[here].
-
-[discrete]
-===== More lenient parameter checks https://github.com/elastic/elasticsearch-js/pull/1662[#1662]
-
-When creating a new client, an `undefined` `caFingerprint` no longer trigger an error for a http connection.
-
-[discrete]
-===== Update TypeScript docs and export estypes https://github.com/elastic/elasticsearch-js/pull/1675[#1675]
-
-You can import the full TypeScript requests & responses definitions as it follows:
-[source,ts]
-----
-import { estypes } from '@elastic/elasticsearch'
-----
-
-If you need the legacy definitions with the body, you can do the following:
-
-[source,ts]
-----
-import { estypesWithBody } from '@elastic/elasticsearch'
-----
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Updated hpagent to the latest version https://github.com/elastic/elastic-transport-js/pull/49[transport/#49]
-
-You can fing the related changes https://github.com/delvedor/hpagent/releases/tag/v1.0.0[here].
-
-[discrete]
-=== 8.1.0
-
-[discrete]
-==== Features
-
-[discrete]
-===== Support for Elasticsearch `v8.1`
-
-You can find all the API changes
-https://www.elastic.co/guide/en/elasticsearch/reference/8.1/release-notes-8.1.0.html[here].
-
-[discrete]
-===== Export SniffingTransport https://github.com/elastic/elasticsearch-js/pull/1653[#1653]
-
-Now the client exports the SniffingTransport class.
-
-[discrete]
-==== Fixes
-
-[discrete]
-===== Fix onFlushTimeout timer not being cleared when upstream errors https://github.com/elastic/elasticsearch-js/pull/1616[#1616]
-
-Fixes a memory leak caused by an error in the upstream dataset of the bulk helper.
-
-[discrete]
-===== Cleanup abort listener https://github.com/elastic/elastic-transport-js/pull/42[transport/#42]
-
-The legacy http client was not cleaning up the abort listener, which could cause a memory leak.
-
-[discrete]
-===== Improve undici performances https://github.com/elastic/elastic-transport-js/pull/41[transport/#41]
-
-Improve the stream body collection and keep alive timeout.
-
-[discrete]
-=== 8.0.0
-
-[discrete]
-==== Features
-
-[discrete]
-===== Support for Elasticsearch `v8.0`
-
-You can find all the API changes
-https://www.elastic.co/guide/en/elasticsearch/reference/8.0/release-notes-8.0.0.html[here].
-
-[discrete]
-===== Drop old typescript definitions
-
-*Breaking: Yes* | *Migration effort: Medium*
-
-The current TypeScript definitions will be removed from the client, and the new definitions, which contain request and response definitions as well will be shipped by default.
-
-[discrete]
-===== Drop callback-style API
-
-*Breaking: Yes* | *Migration effort: Large*
-
-Maintaining both API styles is not a problem per se, but it makes error handling more convoluted due to async stack traces.
-Moving to a full-promise API will solve this issue.
-
-[source,js]
-----
-// callback-style api
-client.search({ params }, { options }, (err, result) => {
- console.log(err || result)
-})
-
-// promise-style api
-client.search({ params }, { options })
-  .then(console.log)
-  .catch(console.log)
-
-// async-style (sugar syntax on top of promises)
-const response = await client.search({ params }, { options })
-console.log(response)
-----
-
-If you are already using the promise-style API, this won't be a breaking change for you.
-
-[discrete]
-===== Remove the current abort API and use the new AbortController standard
-
-*Breaking: Yes* | *Migration effort: Small*
-
-The old abort API makes sense for callbacks but it's annoying to use with promises
-
-[source,js]
-----
-// callback-style api
-const request = client.search({ params }, { options }, (err, result) => {
- console.log(err) // RequestAbortedError
-})
-
-request.abort()
-
-// promise-style api
-const promise = client.search({ params }, { options })
-
-promise
-  .then(console.log)
-  .catch(console.log) // RequestAbortedError
-
-promise.abort()
-----
-
-Node v12 has added the standard https://nodejs.org/api/globals.html#globals_class_abortcontroller[`AbortController`] API which is designed to work well with both callbacks and promises.
-[source,js]
-----
-const ac = new AbortController()
-client.search({ params }, { signal: ac.signal })
-  .then(console.log)
-  .catch(console.log) // RequestAbortedError
-
-ac.abort()
-----
-
-[discrete]
-===== Remove the body key from the request
-
-*Breaking: Yes* | *Migration effort: Small*
-
-Thanks to the new types we are developing now we know exactly where a parameter should go.
-The client API leaks HTTP-related notions in many places, and removing them would definitely improve the DX.
-
-This could be a rather big breaking change, so a double solution could be used during the 8.x lifecycle. (accepting body keys without them being wrapped in the body as well as the current solution).
-
-To convert code from 7.x, you need to remove the `body` parameter in all the endpoints request.
-For instance, this is an example for the `search` endpoint:
-
-[source,js]
-----
-// from
-const response = await client.search({
-  index: 'test',
-  body: {
-    query: {
-      match_all: {}
-    }
-  }
-})
-
-// to
-const response = await client.search({
-  index: 'test',
-  query: {
-    match_all: {}
-  }
-})
-----
-
-[discrete]
-===== Migrate to new separate transport
-
-*Breaking: Yes* | *Migration effort: Small to none*
-
-The separated transport has been rewritten in TypeScript and has already dropped the callback style API.
-Given that now is separated, most of the Elasticsearch specific concepts have been removed, and the client will likely need to extend parts of it for reintroducing them.
-If you weren't extending the internals of the client, this won't be a breaking change for you.
-
-[discrete]
-===== The returned value of API calls is the body and not the HTTP related keys
-
-*Breaking: Yes* | *Migration effort: Small*
-
-The client API leaks HTTP-related notions in many places, and removing them would definitely improve the DX.
-The client will expose a new request-specific option to still get the full response details.
-
-The new behaviour returns the `body` value directly as response.
-If you want to have the 7.x response format, you need to add `meta : true` in the request.
-This will return all the HTTP meta information, including the `body`.
-
-For instance, this is an example for the `search` endpoint:
-
-[source,js]
-----
-// from
-const response = await client.search({
-  index: 'test',
-  body: {
-    query: {
-      match_all: {}
-    }
-  }
-})
-console.log(response) // { body: SearchResponse, statusCode: number, headers: object, warnings: array }
-
-// to
-const response = await client.search({
-  index: 'test',
-  query: {
-    match_all: {}
-  }
-})
-console.log(response) // SearchResponse
-
-// with a bit of TypeScript and JavaScript magic...
-const response = await client.search({
-  index: 'test',
-  query: {
-    match_all: {}
-  }
-}, {
-  meta: true
-})
-console.log(response) // { body: SearchResponse, statusCode: number, headers: object, warnings: array }
-----
-
-[discrete]
-===== Use a weighted connection pool
-
-*Breaking: Yes* | *Migration effort: Small to none*
-
-Move from the current cluster connection pool to a weight-based implementation.
-This new implementation offers better performances and runs less code in the background, the old connection pool can still be used.
-If you weren't extending the internals of the client, this won't be a breaking change for you.
-
-[discrete]
-===== Migrate to the "undici" http client
-
-*Breaking: Yes* | *Migration effort: Small to none*
-
-By default, the HTTP client will no longer be the default Node.js HTTP client, but https://github.com/nodejs/undici[undici] instead.
-Undici is a brand new HTTP client written from scratch, it offers vastly improved performances and has better support for promises.
-Furthermore, it offers comprehensive and predictable error handling. The old HTTP client can still be used.
-If you weren't extending the internals of the client, this won't be a breaking change for you.
-
-[discrete]
-===== Drop support for old camelCased keys
-
-*Breaking: Yes* | *Migration effort: Medium*
-
-Currently, every path or query parameter could be expressed in both `snake_case` and `camelCase`. Internally the client will convert everything to `snake_case`.
-This was done in an effort to reduce the friction of migrating from the legacy to the new client, but now it no longer makes sense.
-If you are already using `snake_case` keys, this won't be a breaking change for you.
-
-[discrete]
-===== Rename `ssl` option to `tls`
-
-*Breaking: Yes* | *Migration effort: Small*
-
-People usually refers to this as `tls`, furthermore, internally we use the tls API and Node.js refers to it as tls everywhere.
-[source,js]
-----
-// before
-const client = new Client({
-  node: 'https://localhost:9200',
-  ssl: {
-    rejectUnauthorized: false
-  }
-})
-
-// after
-const client = new Client({
-  node: 'https://localhost:9200',
-  tls: {
-    rejectUnauthorized: false
-  }
-})
-----
-
-[discrete]
-===== Remove prototype poisoning protection
-
-*Breaking: Yes* | *Migration effort: Small*
-
-Prototype poisoning protection is very useful, but it can cause performances issues with big payloads.
-In v8 it will be removed, and the documentation will show how to add it back with a custom serializer.
-
-[discrete]
-===== Remove client extensions API
-
-*Breaking: Yes* | *Migration effort: Large*
-
-Nowadays the client support the entire Elasticsearch API, and the `transport.request` method can be used if necessary. The client extensions API have no reason to exist.
-[source,js]
-----
-client.extend('utility.index', ({ makeRequest }) => {
-  return function _index (params, options) {
-    // your code
-  }
-})
-
-client.utility.index(...)
-----
-
-If you weren't using client extensions, this won't be a breaking change for you.
-
-[discrete]
-===== Move to TypeScript
-
-*Breaking: No* | *Migration effort: None*
-
-The new separated transport is already written in TypeScript, and it makes sense that the client v8 will be fully written in TypeScript as well.
-
-[discrete]
-===== Move from emitter-like interface to a diagnostic method
-
-*Breaking: Yes* | *Migration effort: Small*
-
-Currently, the client offers a subset of methods of the `EventEmitter` class, v8 will ship with a `diagnostic` property which will be a proper event emitter.
-[source,js]
-----
-// from
-client.on('request', console.log)
-
-// to
-client.diagnostic.on('request', console.log)
-----
-
-[discrete]
-===== Remove username & password properties from Cloud configuration
-
-*Breaking: Yes* | *Migration effort: Small*
-
-The Cloud configuration does not support ApiKey and Bearer auth, while the `auth` options does.
-There is no need to keep the legacy basic auth support in the cloud configuration.
-[source,js]
-----
-// before
-const client = new Client({
-  cloud: {
-    id: '<cloud-id>',
-    username: 'elastic',
-    password: 'changeme'
-  }
-})
-
-// after
-const client = new Client({
-  cloud: {
-    id: '<cloud-id>'
-  },
-  auth: {
-    username: 'elastic',
-    password: 'changeme'
-  }
-})
-----
-
-If you are already passing the basic auth options in the `auth` configuration, this won't be a breaking change for you.
-
-[discrete]
-===== Calling `client.close` will reject new requests
-
-Once you call `client.close` every new request after that will be rejected with a `NoLivingConnectionsError`. In-flight requests will be executed normally unless an in-flight request requires a retry, in which case it will be rejected.
-
-[discrete]
-===== Parameters rename
-
-- `ilm.delete_lifecycle`: `policy` parameter has been renamed to `name`
-- `ilm.get_lifecycle`: `policy` parameter has been renamed to `name`
-- `ilm.put_lifecycle`: `policy` parameter has been renamed to `name`
-- `snapshot.cleanup_repository`: `repository` parameter has been renamed to `name`
-- `snapshot.create_repository`: `repository` parameter has been renamed to `name`
-- `snapshot.delete_repository`: `repository` parameter has been renamed to `name`
-- `snapshot.get_repository`: `repository` parameter has been renamed to `name`
-- `snapshot.verify_repository`: `repository` parameter has been renamed to `name`
-
-[discrete]
-===== Removal of snake_cased methods
-
-The v7 client provided snake_cased methods, such as `client.delete_by_query`. This is no longer supported, now only camelCased method are present.
-So `client.delete_by_query` can be accessed with `client.deleteByQuery`
-

docs/child.asciidoc

@@ -1,36 +0,0 @@
-[[child]]
-=== Creating a child client
-
-There are some use cases where you may need multiple instances of the client. 
-You can easily do that by calling `new Client()` as many times as you need, but 
-you will lose all the benefits of using one single client, such as the long 
-living connections and the connection pool handling. To avoid this problem, the 
-client offers a `child` API, which returns a new client instance that shares the 
-connection pool with the parent client.
-
-NOTE: The event emitter is shared between the parent and the child(ren). If you 
-extend the parent client, the child client will have the same extensions, while 
-if the child client adds an extension, the parent client will not be extended.
-
-You can pass to the `child` every client option you would pass to a normal 
-client, but the connection pool specific options (`ssl`, `agent`, `pingTimeout`, 
-`Connection`, and `resurrectStrategy`).
-
-CAUTION: If you call `close` in any of the parent/child clients, every client 
-will be closed.
-
-[source,js]
-----
-const { Client } = require('@elastic/elasticsearch')
-const client = new Client({
-  cloud: { id: '<cloud-id>' },
-  auth: { apiKey: 'base64EncodedKey' }
-})
-const child = client.child({
-  headers: { 'x-foo': 'bar' },
-  requestTimeout: 1000
-})
-
-client.info().then(console.log, console.log)
-child.info().then(console.log, console.log)
-----

docs/configuration.asciidoc

@@ -1,12 +0,0 @@
-[[client-configuration]]
-== Configuration
-
-
-The client is designed to be easily configured for your needs. In the following
-section, you can see the possible options that you can use to configure it.
-
-* <<basic-config>>
-* <<advanced-config>>
-* <<timeout-best-practices>>
-* <<child>>
-* <<client-testing>>

docs/connecting.asciidoc

@@ -1,738 +0,0 @@
-[[client-connecting]]
-== Connecting
-
-This page contains the information you need to connect and use the Client with
-{es}.
-
-**On this page**
-
-* <<authentication, Authentication options>>
-* <<client-usage, Using the client>>
-* <<client-faas-env, Using the Client in a Function-as-a-Service Environment>>
-* <<client-connect-proxy, Connecting through a proxy>>
-* <<client-error-handling, Handling errors>>
-* <<keep-alive, Keep-alive connections>>
-* <<close-connections, Closing a client's connections>>
-* <<product-check, Automatic product check>>
-
-[[authentication]]
-[discrete]
-=== Authentication
-
-This document contains code snippets to show you how to connect to various {es}
-providers.
-
-
-[discrete]
-[[auth-ec]]
-==== Elastic Cloud
-
-If you are using https://www.elastic.co/cloud[Elastic Cloud], the client offers
-an easy way to connect to it via the `cloud` option. You must pass the Cloud ID
-that you can find in the cloud console, then your username and password inside
-the `auth` option.
-
-NOTE: When connecting to Elastic Cloud, the client will automatically enable
-both request and response compression by default, since it yields significant
-throughput improvements. Moreover, the client will also set the tls option
-`secureProtocol` to `TLSv1_2_method` unless specified otherwise. You can still
-override this option by configuring them.
-
-IMPORTANT: Do not enable sniffing when using Elastic Cloud, since the nodes are
-behind a load balancer, Elastic Cloud will take care of everything for you.
-Take a look https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how[here]
-to know more.
-
-[source,js]
-----
-const { Client } = require('@elastic/elasticsearch')
-const client = new Client({
-  cloud: {
-    id: '<cloud-id>'
-  },
-  auth: {
-    username: 'elastic',
-    password: 'changeme'
-  }
-})
-----
-
-[discrete]
-[[connect-self-managed-new]]
-=== Connecting to a self-managed cluster
-
-By default {es} will start with security features like authentication and TLS
-enabled. To connect to the {es} cluster you'll need to configure the Node.js {es}
-client to use HTTPS with the generated CA certificate in order to make requests
-successfully.
-
-If you're just getting started with {es} we recommend reading the documentation
-on https://www.elastic.co/guide/en/elasticsearch/reference/current/settings.html[configuring]
-and
-https://www.elastic.co/guide/en/elasticsearch/reference/current/starting-elasticsearch.html[starting {es}]
-to ensure your cluster is running as expected.
-
-When you start {es} for the first time you'll see a distinct block like the one
-below in the output from {es} (you may have to scroll up if it's been a while):
-
-[source,sh]
-----
-
--> Elasticsearch security features have been automatically configured!
--> Authentication is enabled and cluster connections are encrypted.
-
-->  Password for the elastic user (reset with `bin/elasticsearch-reset-password -u elastic`):
-  lhQpLELkjkrawaBoaz0Q
-
-->  HTTP CA certificate SHA-256 fingerprint:
-  a52dd93511e8c6045e21f16654b77c9ee0f34aea26d9f40320b531c474676228
-...
-
-----
-
-Depending on the circumstances there are two options for verifying the HTTPS
-connection, either verifying with the CA certificate itself or via the HTTP CA
-certificate fingerprint.
-
-[discrete]
-[[auth-tls]]
-==== TLS configuration
-
-The generated root CA certificate can be found in the `certs` directory in your
-{es} config location (`$ES_CONF_PATH/certs/http_ca.crt`). If you're running {es}
-in Docker there is
-https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html[additional documentation for retrieving the CA certificate].
-
-Without any additional configuration you can specify `https://` node urls, and
-the certificates used to sign these requests will be verified. To turn off
-certificate verification, you must specify an `tls` object in the top level
-config and set `rejectUnauthorized: false`. The default `tls` values are the
-same that Node.js's https://nodejs.org/api/tls.html#tls_tls_connect_options_callback[`tls.connect()`]
-uses.
-
-[source,js]
-----
-const { Client } = require('@elastic/elasticsearch')
-const client = new Client({
-  node: 'https://localhost:9200',
-  auth: {
-    username: 'elastic',
-    password: 'changeme'
-  },
-  tls: {
-    ca: fs.readFileSync('./http_ca.crt'),
-    rejectUnauthorized: false
-  }
-})
-----
-
-[discrete]
-[[auth-ca-fingerprint]]
-==== CA fingerprint
-
-You can configure the client to only trust certificates that are signed by a specific CA certificate
-(CA certificate pinning) by providing a `caFingerprint` option.
-This will verify that the fingerprint of the CA certificate that has signed
-the certificate of the server matches the supplied value.
-You must configure a SHA256 digest.
-
-[source,js]
-----
-const { Client } = require('@elastic/elasticsearch')
-const client = new Client({
-  node: 'https://example.com'
-  auth: { ... },
-  // the fingerprint (SHA256) of the CA certificate that is used to sign
-  // the certificate that the Elasticsearch node presents for TLS.
-  caFingerprint: '20:0D:CA:FA:76:...',
-  tls: {
-    // might be required if it's a self-signed certificate
-    rejectUnauthorized: false
-  }
-})
-----
-
-The certificate fingerprint can be calculated using `openssl x509` with the
-certificate file:
-
-[source,sh]
-----
-openssl x509 -fingerprint -sha256 -noout -in /path/to/http_ca.crt
-----
-
-If you don't have access to the generated CA file from {es} you can use the
-following script to output the root CA fingerprint of the {es} instance with
-`openssl s_client`:
-
-[source,sh]
-----
-# Replace the values of 'localhost' and '9200' to the
-# corresponding host and port values for the cluster.
-openssl s_client -connect localhost:9200 -servername localhost -showcerts </dev/null 2>/dev/null \
-  | openssl x509 -fingerprint -sha256 -noout -in /dev/stdin
-----
-
-The output of `openssl x509` will look something like this:
-
-[source,sh]
-----
-SHA256 Fingerprint=A5:2D:D9:35:11:E8:C6:04:5E:21:F1:66:54:B7:7C:9E:E0:F3:4A:EA:26:D9:F4:03:20:B5:31:C4:74:67:62:28
-----
-
-
-[discrete]
-[[connect-no-security]]
-=== Connecting without security enabled
-
-WARNING: Running {es} without security enabled is not recommended.
-
-If your cluster is configured with
-https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html[security explicitly disabled]
-then you can connect via HTTP:
-
-[source,js]
-----
-const { Client } = require('@elastic/elasticsearch')
-const client = new Client({
-  node: 'http://example.com'
-})
-----
-
-[discrete]
-[[auth-strategies]]
-=== Authentication strategies
-
-Following you can find all the supported authentication strategies.
-
-[discrete]
-[[auth-apikey]]
-==== ApiKey authentication
-
-You can use the
-{ref-7x}/security-api-create-api-key.html[ApiKey]
-authentication by passing the `apiKey` parameter via the `auth` option. The
-`apiKey` parameter can be either a base64 encoded string or an object with the
-values that you can obtain from the
-{ref-7x}/security-api-create-api-key.html[create api key endpoint].
-
-NOTE: If you provide both basic authentication credentials and the ApiKey
-configuration, the ApiKey takes precedence.
-
-[source,js]
-----
-const { Client } = require('@elastic/elasticsearch')
-const client = new Client({
-  node: 'https://localhost:9200',
-  auth: {
-    apiKey: 'base64EncodedKey'
-  }
-})
-----
-
-[source,js]
-----
-const { Client } = require('@elastic/elasticsearch')
-const client = new Client({
-  node: 'https://localhost:9200',
-  auth: {
-    apiKey: {
-      id: 'foo',
-      api_key: 'bar'
-    }
-  }
-})
-----
-
-[discrete]
-[[auth-bearer]]
-==== Bearer authentication
-
-You can provide your credentials by passing the `bearer` token
-parameter via the `auth` option.
-Useful for https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-service-token.html[service account tokens].
-Be aware that it does not handle automatic token refresh.
-
-[source,js]
-----
-const { Client } = require('@elastic/elasticsearch')
-const client = new Client({
-  node: 'https://localhost:9200',
-  auth: {
-    bearer: 'token'
-  }
-})
-----
-
-
-[discrete]
-[[auth-basic]]
-==== Basic authentication
-
-You can provide your credentials by passing the `username` and `password`
-parameters via the `auth` option.
-
-NOTE: If you provide both basic authentication credentials and the Api Key
-configuration, the Api Key will take precedence.
-
-[source,js]
-----
-const { Client } = require('@elastic/elasticsearch')
-const client = new Client({
-  node: 'https://localhost:9200',
-  auth: {
-    username: 'elastic',
-    password: 'changeme'
-  }
-})
-----
-
-
-Otherwise, you can provide your credentials in the node(s) URL.
-
-[source,js]
-----
-const { Client } = require('@elastic/elasticsearch')
-const client = new Client({
-  node: 'https://username:password@localhost:9200'
-})
-----
-
-
-[discrete]
-[[client-usage]]
-=== Usage
-
-Using the client is straightforward, it supports all the public APIs of {es},
-and every method exposes the same signature.
-
-
-[source,js]
-----
-const { Client } = require('@elastic/elasticsearch')
-const client = new Client({
-  cloud: { id: '<cloud-id>' },
-  auth: { apiKey: 'base64EncodedKey' }
-})
-
-const result = await client.search({
-  index: 'my-index',
-  query: {
-    match: { hello: 'world' }
-  }
-})
-----
-
-The returned value of every API call is the response body from {es}.
-If you need to access additonal metadata, such as the status code or headers,
-you must specify `meta: true` in the request options:
-
-[source,js]
-----
-const { Client } = require('@elastic/elasticsearch')
-const client = new Client({
-  cloud: { id: '<cloud-id>' },
-  auth: { apiKey: 'base64EncodedKey' }
-})
-
-const result = await client.search({
-  index: 'my-index',
-  query: {
-    match: { hello: 'world' }
-  }
-}, { meta: true })
-----
-
-In this case, the result will be:
-[source,ts]
-----
-{
-  body: object | boolean
-  statusCode: number
-  headers: object
-  warnings: string[],
-  meta: object
-}
-----
-
-NOTE: The body is a boolean value when you use `HEAD` APIs.
-
-[discrete]
-==== Aborting a request
-
-If needed, you can abort a running request by using the `AbortController` standard.
-
-CAUTION: If you abort a request, the request will fail with a
-`RequestAbortedError`.
-
-
-[source,js]
-----
-const AbortController = require('node-abort-controller')
-const { Client } = require('@elastic/elasticsearch')
-const client = new Client({
-  cloud: { id: '<cloud-id>' },
-  auth: { apiKey: 'base64EncodedKey' }
-})
-
-const abortController = new AbortController()
-setImmediate(() => abortController.abort())
-
-const result = await client.search({
-  index: 'my-index',
-  query: {
-    match: { hello: 'world' }
-  }
-}, { signal: abortController.signal })
-----
-
-[discrete]
-==== Request specific options
-
-If needed you can pass request specific options in a second object:
-
-[source,js]
-----
-const result = await client.search({
-  index: 'my-index',
-  body: {
-    query: {
-      match: { hello: 'world' }
-    }
-  }
-}, {
-  ignore: [404],
-  maxRetries: 3
-})
-----
-
-
-The supported request specific options are:
-[cols=2*]
-|===
-|`ignore`
-|`number[]` -  HTTP status codes which should not be considered errors for this request. +
-_Default:_ `null`
-
-|`requestTimeout`
-|`number | string` - Max request timeout for the request in milliseconds, it overrides the client default. +
-_Default:_ `30000`
-
-|`retryOnTimeout`
-|`boolean` - Retry requests that have timed out.
-_Default:_ `false`
-
-|`maxRetries`
-|`number` - Max number of retries for the request, it overrides the client default. +
-_Default:_ `3`
-
-|`compression`
-|`string | boolean` - Enables body compression for the request. +
-_Options:_ `false`, `'gzip'` +
-_Default:_ `false`
-
-|`asStream`
-|`boolean` - Instead of getting the parsed body back, you get the raw Node.js stream of data. +
-_Default:_ `false`
-
-|`headers`
-|`object` - Custom headers for the request. +
-_Default:_ `null`
-
-|`querystring`
-|`object` - Custom querystring for the request. +
-_Default:_ `null`
-
-|`id`
-|`any` - Custom request id. _(overrides the top level request id generator)_ +
-_Default:_ `null`
-
-|`context`
-|`any` - Custom object per request. _(you can use it to pass data to the clients events)_ +
-_Default:_ `null`
-
-|`opaqueId`
-|`string` - Set the `X-Opaque-Id` HTTP header. See {ref}/api-conventions.html#x-opaque-id
-_Default:_ `null`
-
-|`maxResponseSize`
-|`number` - When configured, it verifies that the uncompressed response size is lower than the configured number, if it's higher it will abort the request. It cannot be higher than buffer.constants.MAX_STRING_LENTGH +
-_Default:_ `null`
-
-|`maxCompressedResponseSize`
-|`number` - When configured, it verifies that the compressed response size is lower than the configured number, if it's higher it will abort the request. It cannot be higher than buffer.constants.MAX_LENTGH +
-_Default:_ `null`
-
-|`signal`
-|`AbortSignal` - The AbortSignal instance to allow request abortion. +
-_Default:_ `null`
-
-|`meta`
-|`boolean` - Rather than returning the body, return an object containing `body`, `statusCode`, `headers` and `meta` keys +
-_Default_: `false`
-
-|`redaction`
-|`object` - Options for redacting potentially sensitive data from error metadata. See <<redaction>>.
-
-|`retryBackoff`
-|`(min: number, max: number, attempt: number) => number;` - A function that calculates how long to sleep, in seconds, before the next request retry +
-_Default:_ A built-in function that uses exponential backoff with jitter.
-
-|===
-
-[discrete]
-[[client-faas-env]]
-=== Using the Client in a Function-as-a-Service Environment
-
-This section illustrates the best practices for leveraging the {es} client in a Function-as-a-Service (FaaS) environment.
-The most influential optimization is to initialize the client outside of the function, the global scope.
-This practice does not only improve performance but also enables background functionality as – for example – https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how[sniffing].
-The following examples provide a skeleton for the best practices.
-
-[discrete]
-==== GCP Cloud Functions
-
-[source,js]
-----
-'use strict'
-
-const { Client } = require('@elastic/elasticsearch')
-
-const client = new Client({
-  // client initialisation
-})
-
-exports.testFunction = async function (req, res) {
-  // use the client
-}
-----
-
-[discrete]
-==== AWS Lambda
-
-[source,js]
-----
-'use strict'
-
-const { Client } = require('@elastic/elasticsearch')
-
-const client = new Client({
-  // client initialisation
-})
-
-exports.handler = async function (event, context) {
-  // use the client
-}
-----
-
-[discrete]
-==== Azure Functions
-
-[source,js]
-----
-'use strict'
-
-const { Client } = require('@elastic/elasticsearch')
-
-const client = new Client({
-  // client initialisation
-})
-
-module.exports = async function (context, req) {
-  // use the client
-}
-----
-
-Resources used to assess these recommendations:
-
-- https://cloud.google.com/functions/docs/bestpractices/tips#use_global_variables_to_reuse_objects_in_future_invocations[GCP Cloud Functions: Tips & Tricks]
-- https://docs.aws.amazon.com/lambda/latest/dg/best-practices.html[Best practices for working with AWS Lambda functions]
-- https://docs.microsoft.com/en-us/azure/azure-functions/functions-reference-python?tabs=azurecli-linux%2Capplication-level#global-variables[Azure Functions Python developer guide]
-- https://docs.aws.amazon.com/lambda/latest/operatorguide/global-scope.html[AWS Lambda: Comparing the effect of global scope]
-
-
-[discrete]
-[[client-connect-proxy]]
-=== Connecting through a proxy
-
-~Added~ ~in~ ~`v7.10.0`~
-
-If you need to pass through an http(s) proxy for connecting to {es}, the client
-out of the box offers a handy configuration for helping you with it. Under the
-hood, it uses the https://github.com/delvedor/hpagent[`hpagent`] module.
-
-IMPORTANT: In versions 8.0+ of the client, the default `Connection` type is set to `UndiciConnection`, which does not support proxy configurations.
-To use a proxy, you will need to use the `HttpConnection` class from `@elastic/transport` instead.
-
-[source,js]
-----
-import { HttpConnection } from '@elastic/transport'
-
-const client = new Client({
-  node: 'http://localhost:9200',
-  proxy: 'http://localhost:8080',
-  Connection: HttpConnection,
-})
-----
-
-Basic authentication is supported as well:
-
-[source,js]
-----
-const client = new Client({
-  node: 'http://localhost:9200',
-  proxy: 'http:user:pwd@//localhost:8080',
-  Connection: HttpConnection,
-})
-----
-
-If you are connecting through a non-http(s) proxy, such as a `socks5` or `pac`,
-you can use the `agent` option to configure it.
-
-[source,js]
-----
-const SocksProxyAgent = require('socks-proxy-agent')
-const client = new Client({
-  node: 'http://localhost:9200',
-  agent () {
-    return new SocksProxyAgent('socks://127.0.0.1:1080')
-  },
-  Connection: HttpConnection,
-})
-----
-
-
-[discrete]
-[[client-error-handling]]
-=== Error handling
-
-The client exposes a variety of error objects that you can use to enhance your
-error handling. You can find all the error objects inside the `errors` key in
-the client.
-
-[source,js]
-----
-const { errors } = require('@elastic/elasticsearch')
-console.log(errors)
-----
-
-
-You can find the errors exported by the client in the table below.
-
-[cols=3*]
-|===
-|*Error*
-|*Description*
-|*Properties*
-
-|`ElasticsearchClientError`
-|Every error inherits from this class, it is the basic error generated by the client.
-a|* `name` - `string`
-* `message` - `string`
-
-|`TimeoutError`
-|Generated when a request exceeds the `requestTimeout` option.
-a|* `name` - `string`
-* `message` - `string`
-* `meta` - `object`, contains all the information about the request
-
-|`ConnectionError`
-|Generated when an error occurs during the request, it can be a connection error or a malformed stream of data.
-a|* `name` - `string`
-* `message` - `string`
-* `meta` - `object`, contains all the information about the request
-
-|`RequestAbortedError`
-|Generated if the user calls the `request.abort()` method.
-a|* `name` - `string`
-* `message` - `string`
-* `meta` - `object`, contains all the information about the request
-
-|`NoLivingConnectionsError`
-|Given the configuration, the ConnectionPool was not able to find a usable Connection for this request.
-a|* `name` - `string`
-* `message` - `string`
-* `meta` - `object`, contains all the information about the request
-
-|`SerializationError`
-|Generated if the serialization fails.
-a|* `name` - `string`
-* `message` - `string`
-* `data` - `object`, the object to serialize
-
-|`DeserializationError`
-|Generated if the deserialization fails.
-a|* `name` - `string`
-* `message` - `string`
-* `data` - `string`, the string to deserialize
-
-|`ConfigurationError`
-|Generated if there is a malformed configuration or parameter.
-a|* `name` - `string`
-* `message` - `string`
-
-|`ResponseError`
-|Generated when in case of a `4xx` or `5xx` response.
-a|* `name` - `string`
-* `message` - `string`
-* `meta` - `object`, contains all the information about the request
-* `body` - `object`, the response body
-* `statusCode` - `object`, the response headers
-* `headers` - `object`, the response status code
-|===
-
-[[keep-alive]]
-[discrete]
-=== Keep-alive connections
-
-By default, the client uses persistent, keep-alive connections to reduce the overhead of creating a new HTTP connection for each Elasticsearch request.
-If you are using the default `UndiciConnection` connection class, it maintains a pool of 256 connections with a keep-alive of 10 minutes.
-If you are using the legacy `HttpConnection` connection class, it maintains a pool of 256 connections with a keep-alive of 1 minute.
-
-If you need to disable keep-alive connections, you can override the HTTP agent with your preferred https://nodejs.org/api/http.html#http_new_agent_options[HTTP agent options]:
-
-[source,js]
-----
-const client = new Client({
-  node: 'http://localhost:9200',
-  // the function takes as parameter the option
-  // object passed to the Connection constructor
-  agent: (opts) => new CustomAgent()
-})
-----
-
-Or you can disable the HTTP agent entirely:
-
-[source,js]
-----
-const client = new Client({
-  node: 'http://localhost:9200',
-  // Disable agent and keep-alive
-  agent: false
-})
-----
-
-[discrete]
-[[close-connections]]
-=== Closing a client's connections
-
-If you would like to close all open connections being managed by an instance of the client, use the `close()` function:
-
-[source,js]
-----
-const client = new Client({
-  node: 'http://localhost:9200'
-});
-client.close();
-----
-
-[discrete]
-[[product-check]]
-=== Automatic product check
-
-Since v7.14.0, the client performs a required product check before the first call.
-This pre-flight product check allows the client to establish the version of Elasticsearch
-that it is communicating with. The product check requires one additional HTTP request to
-be sent to the server as part of the request pipeline before the main API call is sent.
-In most cases, this will succeed during the very first API call that the client sends.
-Once the product check completes, no further product check HTTP requests are sent for
-subsequent API calls.

docs/doc_examples/120fcf9f55128d6a81d5e87a9c235bbd.asciidoc

@@ -3,16 +3,17 @@
 
 [source, js]
 ----
-const response = await client.inference.streamInference({
-  task_type: "chat_completion",
+const response = await client.inference.chatCompletionUnified({
   inference_id: "openai-completion",
-  model: "gpt-4o",
-  messages: [
-    {
-      role: "user",
-      content: "What is Elastic?",
-    },
-  ],
+  chat_completion_request: {
+    model: "gpt-4o",
+    messages: [
+      {
+        role: "user",
+        content: "What is Elastic?",
+      },
+    ],
+  },
 });
 console.log(response);
 ----

docs/doc_examples/13ecdf99114098c76b050397d9c3d4e6.asciidoc

@@ -3,8 +3,7 @@
 
 [source, js]
 ----
-const response = await client.inference.inference({
-  task_type: "sparse_embedding",
+const response = await client.inference.sparseEmbedding({
   inference_id: "my-elser-model",
   input:
     "The sky above the port was the color of television tuned to a dead channel.",

docs/doc_examples/45954b8aaedfed57012be8b6538b0a24.asciidoc

@@ -3,41 +3,42 @@
 
 [source, js]
 ----
-const response = await client.inference.streamInference({
-  task_type: "chat_completion",
+const response = await client.inference.chatCompletionUnified({
   inference_id: "openai-completion",
-  messages: [
-    {
-      role: "user",
-      content: [
-        {
-          type: "text",
-          text: "What's the price of a scarf?",
-        },
-      ],
-    },
-  ],
-  tools: [
-    {
-      type: "function",
-      function: {
-        name: "get_current_price",
-        description: "Get the current price of a item",
-        parameters: {
-          type: "object",
-          properties: {
-            item: {
-              id: "123",
+  chat_completion_request: {
+    messages: [
+      {
+        role: "user",
+        content: [
+          {
+            type: "text",
+            text: "What's the price of a scarf?",
+          },
+        ],
+      },
+    ],
+    tools: [
+      {
+        type: "function",
+        function: {
+          name: "get_current_price",
+          description: "Get the current price of a item",
+          parameters: {
+            type: "object",
+            properties: {
+              item: {
+                id: "123",
+              },
             },
           },
         },
       },
-    },
-  ],
-  tool_choice: {
-    type: "function",
-    function: {
-      name: "get_current_price",
+    ],
+    tool_choice: {
+      type: "function",
+      function: {
+        name: "get_current_price",
+      },
     },
   },
 });

docs/doc_examples/4b91ad7c9b44e07db4a4e81390f19ad3.asciidoc

@@ -3,8 +3,7 @@
 
 [source, js]
 ----
-const response = await client.inference.streamInference({
-  task_type: "completion",
+const response = await client.inference.streamCompletion({
   inference_id: "openai-completion",
   input: "What is Elastic?",
 });

docs/doc_examples/7429b16221fe741fd31b0584786dd0b0.asciidoc

@@ -3,8 +3,7 @@
 
 [source, js]
 ----
-const response = await client.inference.inference({
-  task_type: "text_embedding",
+const response = await client.inference.textEmbedding({
   inference_id: "my-cohere-endpoint",
   input:
     "The sky above the port was the color of television tuned to a dead channel.",

docs/doc_examples/82bb6c61dab959f4446dc5ecab7ecbdf.asciidoc

@@ -3,30 +3,31 @@
 
 [source, js]
 ----
-const response = await client.inference.streamInference({
-  task_type: "chat_completion",
+const response = await client.inference.chatCompletionUnified({
   inference_id: "openai-completion",
-  messages: [
-    {
-      role: "assistant",
-      content: "Let's find out what the weather is",
-      tool_calls: [
-        {
-          id: "call_KcAjWtAww20AihPHphUh46Gd",
-          type: "function",
-          function: {
-            name: "get_current_weather",
-            arguments: '{"location":"Boston, MA"}',
+  chat_completion_request: {
+    messages: [
+      {
+        role: "assistant",
+        content: "Let's find out what the weather is",
+        tool_calls: [
+          {
+            id: "call_KcAjWtAww20AihPHphUh46Gd",
+            type: "function",
+            function: {
+              name: "get_current_weather",
+              arguments: '{"location":"Boston, MA"}',
+            },
           },
-        },
-      ],
-    },
-    {
-      role: "tool",
-      content: "The weather is cold",
-      tool_call_id: "call_KcAjWtAww20AihPHphUh46Gd",
-    },
-  ],
+        ],
+      },
+      {
+        role: "tool",
+        content: "The weather is cold",
+        tool_call_id: "call_KcAjWtAww20AihPHphUh46Gd",
+      },
+    ],
+  },
 });
 console.log(response);
 ----

docs/doc_examples/b45a8c6fc746e9c90fd181e69a605fad.asciidoc

@@ -3,8 +3,7 @@
 
 [source, js]
 ----
-const response = await client.inference.inference({
-  task_type: "completion",
+const response = await client.inference.completion({
   inference_id: "openai_chat_completions",
   input: "What is Elastic?",
 });

docs/doc_examples/f1b24217b1d9ba6ea5e4fa6e6f412022.asciidoc

@@ -3,8 +3,7 @@
 
 [source, js]
 ----
-const response = await client.inference.inference({
-  task_type: "rerank",
+const response = await client.inference.rerank({
   inference_id: "cohere_rerank",
   input: ["luke", "like", "leia", "chewy", "r2d2", "star", "wars"],
   query: "star wars main character",

docs/docset.yml

@@ -0,0 +1,14 @@
+project: 'Node.js client'
+products:
+  - id: elasticsearch-client
+exclude:
+  - examples/proxy/README.md
+cross_links:
+  - docs-content
+  - elasticsearch
+toc:
+  - toc: reference
+  - toc: release-notes
+subs:
+  stack:   "Elastic Stack"
+  es:   "Elasticsearch"

docs/examples/index.asciidoc

@@ -1,34 +0,0 @@
-[[examples]]
-== Examples
-
-Following you can find some examples on how to use the client.
-
-* Use of the <<as_stream_examples,asStream>> parameter;
-* Executing a <<bulk_examples,bulk>> request;
-* Executing a <<exists_examples,exists>> request;
-* Executing a <<get_examples,get>> request;
-* Executing a <<sql_query_examples,sql.query>> request;
-* Executing a <<update_examples,update>> request;
-* Executing a <<update_by_query_examples,update by query>> request;
-* Executing a <<reindex_examples,reindex>> request;
-* Use of the <<ignore_examples,ignore>> parameter;
-* Executing a <<msearch_examples,msearch>> request;
-* How do I <<scroll_examples,scroll>>?
-* Executing a <<search_examples,search>> request;
-* I need <<suggest_examples,suggestions>>;
-* How to use the <<transport_request_examples,transport.request>> method;
-
-include::asStream.asciidoc[]
-include::bulk.asciidoc[]
-include::exists.asciidoc[]
-include::get.asciidoc[]
-include::ignore.asciidoc[]
-include::msearch.asciidoc[]
-include::scroll.asciidoc[]
-include::search.asciidoc[]
-include::suggest.asciidoc[]
-include::transport.request.asciidoc[]
-include::sql.query.asciidoc[]
-include::update.asciidoc[]
-include::update_by_query.asciidoc[]
-include::reindex.asciidoc[]

docs/examples/proxy/api/autocomplete.js

@@ -1,20 +1,6 @@
 /*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
  */
 
 // IMPORTANT: this is not a production ready code & purely for demonstration purposes,

docs/examples/proxy/api/delete.js

@@ -1,20 +1,6 @@
 /*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
  */
 
 // IMPORTANT: this is not a production ready code & purely for demonstration purposes,

docs/examples/proxy/api/index.js

@@ -1,20 +1,6 @@
 /*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
  */
 
 // IMPORTANT: this is not a production ready code & purely for demonstration purposes,

docs/examples/proxy/api/search.js

@@ -1,20 +1,6 @@
 /*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
  */
 
 // IMPORTANT: this is not a production ready code & purely for demonstration purposes,

docs/examples/proxy/utils/authorize.js

@@ -1,20 +1,6 @@
 /*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
  */
 
 // IMPORTANT: this is not a production ready code & purely for demonstration purposes,

docs/examples/proxy/utils/prepare-elasticsearch.js

@@ -1,20 +1,6 @@
 /*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
  */
 
 'use strict'

docs/getting-started.asciidoc

@@ -1,170 +0,0 @@
-[[getting-started-js]]
-== Getting started
-
-This page guides you through the installation process of the Node.js client,
-shows you how to instantiate the client, and how to perform basic Elasticsearch 
-operations with it.
-
-[discrete]
-=== Requirements
-
-* https://nodejs.org/[Node.js] version 14.x or newer
-* https://docs.npmjs.com/downloading-and-installing-node-js-and-npm[`npm`], usually bundled with Node.js
-
-[discrete]
-=== Installation 
-
-To install the latest version of the client, run the following command:
-
-[source,shell]
---------------------------
-npm install @elastic/elasticsearch
---------------------------
-
-Refer to the <<installation>> page to learn more.
-
-
-[discrete]
-=== Connecting
-
-You can connect to the Elastic Cloud using an API key and the Elasticsearch 
-endpoint. 
-
-[source,js]
-----
-const { Client } = require('@elastic/elasticsearch')
-const client = new Client({
-  node: 'https://...', // Elasticsearch endpoint
-  auth: {
-    apiKey: { // API key ID and secret
-      id: 'foo',
-      api_key: 'bar',
-    }
-  }
-})
-----
-
-Your Elasticsearch endpoint can be found on the **My deployment** page of your 
-deployment:
-
-image::images/es-endpoint.jpg[alt="Finding Elasticsearch endpoint",align="center"]
-
-You can generate an API key on the **Management** page under Security.
-
-image::images/create-api-key.png[alt="Create API key",align="center"]
-
-For other connection options, refer to the <<client-connecting>> section.
-
-
-[discrete]
-=== Operations
-
-Time to use Elasticsearch! This section walks you through the basic, and most 
-important, operations of Elasticsearch.
-
-
-[discrete]
-==== Creating an index
-
-This is how you create the `my_index` index:
-
-[source,js]
-----
-await client.indices.create({ index: 'my_index' })
-----
-
-
-[discrete]
-==== Indexing documents
-
-This is a simple way of indexing a document:
-
-[source,js]
-----
-await client.index({
-  index: 'my_index',
-  id: 'my_document_id',
-  document: {
-    foo: 'foo',
-    bar: 'bar',
-  },
-})
-----
-
-
-[discrete]
-==== Getting documents
-
-You can get documents by using the following code:
-
-[source,js]
-----
-await client.get({
-  index: 'my_index',
-  id: 'my_document_id',
-})
-----
-
-
-[discrete]
-==== Searching documents
-
-This is how you can create a single match query with the client: 
-
-[source,js]
-----
-await client.search({
-  query: {
-    match: {
-      foo: 'foo'
-    }
-  }
-})
-----
-
-
-[discrete]
-==== Updating documents
-
-This is how you can update a document, for example to add a new field:
-
-[source,js]
-----
-await client.update({
-  index: 'my_index',
-  id: 'my_document_id',
-  doc: {
-    foo: 'bar',
-    new_field: 'new value'
-  }
-})
-----
-
-
-[discrete]
-==== Deleting documents
-
-[source,js]
-----
-await client.delete({
-  index: 'my_index',
-  id: 'my_document_id',
-})
-----
-
-
-[discrete]
-==== Deleting an index
-
-[source,js]
-----
-await client.indices.delete({ index: 'my_index' })
-----
-
-
-[discrete]
-== Further reading
-
-* Use <<client-helpers>> for a more comfortable experience with the APIs.
-* For an elaborate example of how to ingest data into Elastic Cloud, 
-refer to {cloud}/ec-getting-started-node-js.html[this page].

docs/helpers.asciidoc

@@ -1,748 +0,0 @@
-[[client-helpers]]
-== Client helpers
-
-The client comes with an handy collection of helpers to give you a more
-comfortable experience with some APIs.
-
-CAUTION: The client helpers are experimental, and the API may change in the next
-minor releases. The helpers will not work in any Node.js version lower than 10.
-
-
-[discrete]
-[[bulk-helper]]
-=== Bulk helper
-
-~Added~ ~in~ ~`v7.7.0`~
-
-Running bulk requests can be complex due to the shape of the API, this helper
-aims to provide a nicer developer experience around the Bulk API.
-
-
-[discrete]
-==== Usage
-
-[source,js]
-----
-const { createReadStream } = require('fs')
-const split = require('split2')
-const { Client } = require('@elastic/elasticsearch')
-
-const client = new Client({
-  cloud: { id: '<cloud-id>' },
-  auth: { apiKey: 'base64EncodedKey' }
-})
-const result = await client.helpers.bulk({
-  datasource: createReadStream('./dataset.ndjson').pipe(split()),
-  onDocument (doc) {
-    return {
-      index: { _index: 'my-index' }
-    }
-  }
-})
-
-console.log(result)
-// {
-//   total: number,
-//   failed: number,
-//   retry: number,
-//   successful: number,
-//   time: number,
-//   bytes: number,
-//   aborted: boolean
-// }
-----
-
-To create a new instance of the Bulk helper, access it as shown in the example
-above, the configuration options are:
-[cols=2*]
-|===
-|`datasource`
-a|An array, async generator or a readable stream with the data you need to index/create/update/delete.
-It can be an array of strings or objects, but also a stream of json strings or JavaScript objects. +
-If it is a stream, we recommend to use the https://www.npmjs.com/package/split2[`split2`] package, that splits the stream on new lines delimiters. +
-This parameter is mandatory.
-[source,js]
-----
-const { createReadStream } = require('fs')
-const split = require('split2')
-const b = client.helpers.bulk({
-  // if you just use split(), the data will be used as array of strings
-  datasource: createReadStream('./dataset.ndjson').pipe(split())
-  // if you need to manipulate the data, you can pass JSON.parse to split
-  datasource: createReadStream('./dataset.ndjson').pipe(split(JSON.parse))
-})
-----
-
-|`onDocument`
-a|A function that is called for each document of the datasource. Inside this function you can manipulate the document and you must return the operation you want to execute with the document. Look at the link:{ref}/docs-bulk.html[Bulk API documentation] to see the supported operations. +
-This parameter is mandatory.
-[source,js]
-----
-const b = client.helpers.bulk({
-  onDocument (doc) {
-    return {
-      index: { _index: 'my-index' }
-    }
-  }
-})
-----
-
-|`onDrop`
-a|A function that is called for everytime a document can't be indexed and it has reached the maximum amount of retries.
-[source,js]
-----
-const b = client.helpers.bulk({
-  onDrop (doc) {
-    console.log(doc)
-  }
-})
-----
-
-|`onSuccess`
-a|A function that is called for each successful operation in the bulk request, which includes the result from Elasticsearch along with the original document that was sent, or `null` for delete operations.
-[source,js]
-----
-const b = client.helpers.bulk({
-  onSuccess ({ result, document }) {
-    console.log(`SUCCESS: Document ${result.index._id} indexed to ${result.index._index}`)
-  }
-})
-----
-
-|`flushBytes`
-a|The size of the bulk body in bytes to reach before to send it. Default of 5MB. +
-_Default:_ `5000000`
-[source,js]
-----
-const b = client.helpers.bulk({
-  flushBytes: 1000000
-})
-----
-
-|`flushInterval`
-a|How much time (in milliseconds) the helper waits before flushing the body from the last document read. +
-_Default:_ `30000`
-[source,js]
-----
-const b = client.helpers.bulk({
-  flushInterval: 30000
-})
-----
-
-|`concurrency`
-a|How many request is executed at the same time. +
-_Default:_ `5`
-[source,js]
-----
-const b = client.helpers.bulk({
-  concurrency: 10
-})
-----
-
-|`retries`
-a|How many times a document is retried before to call the `onDrop` callback. +
-_Default:_ Client max retries.
-[source,js]
-----
-const b = client.helpers.bulk({
-  retries: 3
-})
-----
-
-|`wait`
-a|How much time to wait before retries in milliseconds. +
-_Default:_ 5000.
-[source,js]
-----
-const b = client.helpers.bulk({
-  wait: 3000
-})
-----
-
-|`refreshOnCompletion`
-a|If `true`, at the end of the bulk operation it runs a refresh on all indices or on the specified indices. +
-_Default:_ false.
-[source,js]
-----
-const b = client.helpers.bulk({
-  refreshOnCompletion: true
-  // or
-  refreshOnCompletion: 'index-name'
-})
-----
-
-|===
-
-
-[discrete]
-==== Supported operations
-
-
-[discrete]
-===== Index
-
-[source,js]
-----
-client.helpers.bulk({
-  datasource: myDatasource,
-  onDocument (doc) {
-    return {
-      index: { _index: 'my-index' }
-    }
-  }
-})
-----
-
-
-[discrete]
-===== Create
-
-[source,js]
-----
-client.helpers.bulk({
-  datasource: myDatasource,
-  onDocument (doc) {
-    return {
-      create: { _index: 'my-index', _id: doc.id }
-    }
-  }
-})
-----
-
-
-[discrete]
-===== Update
-
-[source,js]
-----
-client.helpers.bulk({
-  datasource: myDatasource,
-  onDocument (doc) {
-    // Note that the update operation requires you to return
-    // an array, where the first element is the action, while
-    // the second are the document option
-    return [
-      { update: { _index: 'my-index', _id: doc.id } },
-      { doc_as_upsert: true }
-    ]
-  }
-})
-----
-
-
-[discrete]
-===== Delete
-
-[source,js]
-----
-client.helpers.bulk({
-  datasource: myDatasource,
-  onDocument (doc) {
-    return {
-      delete: { _index: 'my-index', _id: doc.id }
-    }
-  }
-})
-----
-
-
-[discrete]
-==== Abort a bulk operation
-
-If needed, you can abort a bulk operation at any time. The bulk helper returns a
-https://promisesaplus.com/[thenable], which has an `abort` method.
-
-NOTE: The abort method stops the execution of the bulk operation, but if you
-are using a concurrency higher than one, the operations that are already running
-will not be stopped.
-
-[source,js]
-----
-const { createReadStream } = require('fs')
-const split = require('split2')
-const { Client } = require('@elastic/elasticsearch')
-
-const client = new Client({
-  cloud: { id: '<cloud-id>' },
-  auth: { apiKey: 'base64EncodedKey' }
-})
-const b = client.helpers.bulk({
-  datasource: createReadStream('./dataset.ndjson').pipe(split()),
-  onDocument (doc) {
-    return {
-      index: { _index: 'my-index' }
-    }
-  },
-  onDrop (doc) {
-    b.abort()
-  }
-})
-
-console.log(await b)
-----
-
-
-[discrete]
-==== Passing custom options to the Bulk API
-
-You can pass any option supported by the link:
-{ref}/docs-bulk.html#docs-bulk-api-query-params[Bulk API] to the helper, and the
-helper uses those options in conjunction with the Bulk API call.
-
-[source,js]
-----
-const result = await client.helpers.bulk({
-  datasource: [...],
-  onDocument (doc) {
-    return {
-      index: { _index: 'my-index' }
-    }
-  },
-  pipeline: 'my-pipeline'
-})
-----
-
-
-[discrete]
-==== Usage with an async generator
-
-[source,js]
-----
-const { Client } = require('@elastic/elasticsearch')
-
-async function * generator () {
-  const dataset = [
-    { user: 'jon', age: 23 },
-    { user: 'arya', age: 18 },
-    { user: 'tyrion', age: 39 }
-  ]
-  for (const doc of dataset) {
-    yield doc
-  }
-}
-
-const client = new Client({
-  cloud: { id: '<cloud-id>' },
-  auth: { apiKey: 'base64EncodedKey' }
-})
-const result = await client.helpers.bulk({
-  datasource: generator(),
-  onDocument (doc) {
-    return {
-      index: { _index: 'my-index' }
-    }
-  }
-})
-
-console.log(result)
-----
-
-[discrete]
-==== Modifying a document before operation
-
-~Added~ ~in~ ~`v8.8.2`~
-
-If you need to modify documents in your datasource before it is sent to Elasticsearch, you can return an array in the `onDocument` function rather than an operation object. The first item in the array must be the operation object, and the second item must be the document or partial document object as you'd like it to be sent to Elasticsearch.
-
-[source,js]
-----
-const { Client } = require('@elastic/elasticsearch')
-
-const client = new Client({
-  cloud: { id: '<cloud-id>' },
-  auth: { apiKey: 'base64EncodedKey' }
-})
-const result = await client.helpers.bulk({
-  datasource: [...],
-  onDocument (doc) {
-    return [
-      { index: { _index: 'my-index' } },
-      { ...doc, favorite_color: 'mauve' },
-    ]
-  }
-})
-
-console.log(result)
-----
-
-[discrete]
-[[multi-search-helper]]
-=== Multi search helper
-
-~Added~ ~in~ ~`v7.8.0`~
-
-If you send search request at a high rate, this helper might be useful
-for you. It uses the multi search API under the hood to batch the requests
-and improve the overall performances of your application. The `result` exposes a
-`documents` property as well, which allows you to access directly the hits
-sources.
-
-
-[discrete]
-==== Usage
-
-[source,js]
-----
-const { Client } = require('@elastic/elasticsearch')
-
-const client = new Client({
-  cloud: { id: '<cloud-id>' },
-  auth: { apiKey: 'base64EncodedKey' }
-})
-const m = client.helpers.msearch()
-
-m.search(
-    { index: 'stackoverflow' },
-    { query: { match: { title: 'javascript' } } }
-  )
-  .then(result => console.log(result.body)) // or result.documents
-  .catch(err => console.error(err))
-----
-
-To create a new instance of the multi search (msearch) helper, you should access
-it as shown in the example above, the configuration options are:
-[cols=2*]
-|===
-|`operations`
-a|How many search operations should be sent in a single msearch request. +
-_Default:_ `5`
-[source,js]
-----
-const m = client.helpers.msearch({
-  operations: 10
-})
-----
-
-|`flushInterval`
-a|How much time (in milliseconds) the helper waits before flushing the operations from the last operation read. +
-_Default:_ `500`
-[source,js]
-----
-const m = client.helpers.msearch({
-  flushInterval: 500
-})
-----
-
-|`concurrency`
-a|How many request is executed at the same time. +
-_Default:_ `5`
-[source,js]
-----
-const m = client.helpers.msearch({
-  concurrency: 10
-})
-----
-
-|`retries`
-a|How many times an operation is retried before to resolve the request. An operation is retried only in case of a 429 error. +
-_Default:_ Client max retries.
-[source,js]
-----
-const m = client.helpers.msearch({
-  retries: 3
-})
-----
-
-|`wait`
-a|How much time to wait before retries in milliseconds. +
-_Default:_ 5000.
-[source,js]
-----
-const m = client.helpers.msearch({
-  wait: 3000
-})
-----
-
-|===
-
-
-[discrete]
-==== Stopping the msearch helper
-
-If needed, you can stop an msearch processor at any time. The msearch helper
-returns a https://promisesaplus.com/[thenable], which has an `stop` method.
-
-If you are creating multiple msearch helpers instances and using them for a
-limitied period of time, remember to always use the `stop` method once you have
-finished using them, otherwise your application will start leaking memory.
-
-The `stop` method accepts an optional error, that will be dispatched every
-subsequent search request.
-
-NOTE: The stop method stops the execution of the msearch processor, but if
-you are using a concurrency higher than one, the operations that are already
-running will not be stopped.
-
-[source,js]
-----
-const { Client } = require('@elastic/elasticsearch')
-
-const client = new Client({
-  cloud: { id: '<cloud-id>' },
-  auth: { apiKey: 'base64EncodedKey' }
-})
-const m = client.helpers.msearch()
-
-m.search(
-    { index: 'stackoverflow' },
-    { query: { match: { title: 'javascript' } } }
-  )
-  .then(result => console.log(result.body))
-  .catch(err => console.error(err))
-
-m.search(
-    { index: 'stackoverflow' },
-    { query: { match: { title: 'ruby' } } }
-  )
-  .then(result => console.log(result.body))
-  .catch(err => console.error(err))
-
-setImmediate(() => m.stop())
-----
-
-
-[discrete]
-[[search-helper]]
-=== Search helper
-
-~Added~ ~in~ ~`v7.7.0`~
-
-A simple wrapper around the search API. Instead of returning the entire `result`
-object it returns only the search documents source. For improving the
-performances, this helper automatically adds `filter_path=hits.hits._source` to
-the query string.
-
-[source,js]
-----
-const documents = await client.helpers.search({
-  index: 'stackoverflow',
-  query: {
-    match: {
-      title: 'javascript'
-    }
-  }
-})
-
-for (const doc of documents) {
-  console.log(doc)
-}
-----
-
-
-[discrete]
-[[scroll-search-helper]]
-=== Scroll search helper
-
-~Added~ ~in~ ~`v7.7.0`~
-
-This helpers offers a simple and intuitive way to use the scroll search API.
-Once called, it returns an
-https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function[async iterator]
-which can be used in conjuction with a for-await...of. It handles automatically
-the `429` error and uses the `maxRetries` option of the client.
-
-[source,js]
-----
-const scrollSearch = client.helpers.scrollSearch({
-  index: 'stackoverflow',
-  query: {
-    match: {
-      title: 'javascript'
-    }
-  }
-})
-
-for await (const result of scrollSearch) {
-  console.log(result)
-}
-----
-
-
-[discrete]
-==== Clear a scroll search
-
-If needed, you can clear a scroll search by calling `result.clear()`:
-
-[source,js]
-----
-for await (const result of scrollSearch) {
-  if (condition) {
-    await result.clear()
-  }
-}
-----
-
-
-[discrete]
-==== Quickly getting the documents
-
-If you only need the documents from the result of a scroll search, you can
-access them via `result.documents`:
-
-[source,js]
-----
-for await (const result of scrollSearch) {
-  console.log(result.documents)
-}
-----
-
-
-[discrete]
-[[scroll-documents-helper]]
-=== Scroll documents helper
-
-~Added~ ~in~ ~`v7.7.0`~
-
-It works in the same way as the scroll search helper, but it returns only the
-documents instead. Note, every loop cycle returns a single document, and you
-can't use the `clear` method. For improving the performances, this helper
-automatically adds `filter_path=hits.hits._source` to the query string.
-
-[source,js]
-----
-const scrollSearch = client.helpers.scrollDocuments({
-  index: 'stackoverflow',
-  query: {
-    match: {
-      title: 'javascript'
-    }
-  }
-})
-
-for await (const doc of scrollSearch) {
-  console.log(doc)
-}
-----
-
-[discrete]
-[[esql-helper]]
-=== ES|QL helper
-
-ES|QL queries can return their results in {ref}/esql-rest.html#esql-rest-format[several formats].
-The default JSON format returned by ES|QL queries contains arrays of values
-for each row, with column names and types returned separately:
-
-[discrete]
-==== Usage
-
-[discrete]
-===== `toRecords`
-
-~Added~ ~in~ ~`v8.14.0`~
-
-The default JSON format returned by ES|QL queries contains arrays of values
-for each row, with column names and types returned separately:
-
-[source,json]
-----
-{
-  "columns": [
-    { "name": "@timestamp", "type": "date" },
-    { "name": "client_ip", "type": "ip" },
-    { "name": "event_duration", "type": "long" },
-    { "name": "message", "type": "keyword" }
-  ],
-  "values": [
-    [
-      "2023-10-23T12:15:03.360Z",
-      "172.21.2.162",
-      3450233,
-      "Connected to 10.1.0.3"
-    ],
-    [
-      "2023-10-23T12:27:28.948Z",
-      "172.21.2.113",
-      2764889,
-      "Connected to 10.1.0.2"
-    ]
-  ]
-}
-----
-
-In many cases, it's preferable to operate on an array of objects, one object per row,
-rather than an array of arrays. The ES|QL `toRecords` helper converts row data into objects.
-
-[source,js]
-----
-await client.helpers
-  .esql({ query: 'FROM sample_data | LIMIT 2' })
-  .toRecords()
-// =>
-// {
-//   "columns": [
-//     { "name": "@timestamp", "type": "date" },
-//     { "name": "client_ip", "type": "ip" },
-//     { "name": "event_duration", "type": "long" },
-//     { "name": "message", "type": "keyword" }
-//   ],
-//   "records": [
-//     {
-//       "@timestamp": "2023-10-23T12:15:03.360Z",
-//       "client_ip": "172.21.2.162",
-//       "event_duration": 3450233,
-//       "message": "Connected to 10.1.0.3"
-//     },
-//     {
-//       "@timestamp": "2023-10-23T12:27:28.948Z",
-//       "client_ip": "172.21.2.113",
-//       "event_duration": 2764889,
-//       "message": "Connected to 10.1.0.2"
-//     },
-//   ]
-// }
-----
-
-In TypeScript, you can declare the type that `toRecords` returns:
-
-[source,ts]
-----
-type EventLog = {
-  '@timestamp': string,
-  client_ip: string,
-  event_duration: number,
-  message: string,
-}
-
-const result = await client.helpers
-  .esql({ query: 'FROM sample_data | LIMIT 2' })
-  .toRecords<EventLog>()
-----
-
-[discrete]
-===== `toArrowReader`
-
-~Added~ ~in~ ~`v8.16.0`~
-
-ES|QL can return results in multiple binary formats, including https://arrow.apache.org/[Apache Arrow]'s streaming format. Because it is a very efficient format to read, it can be valuable for performing high-performance in-memory analytics. And, because the response is streamed as batches of records, it can be used to produce aggregations and other calculations on larger-than-memory data sets.
-
-`toArrowReader` returns a https://github.com/apache/arrow/blob/520ae44272d491bbb52eb3c9b84864ed7088f11a/js/src/ipc/reader.ts#L216[`AsyncRecordBatchStreamReader`].
-
-[source,ts]
-----
-const reader = await client.helpers
-  .esql({ query: 'FROM sample_data' })
-  .toArrowReader()
-
-// print each record as JSON
-for await (const recordBatch of reader) {
-  for (const record of recordBatch) {
-    console.log(record.toJSON())
-  }
-}
-----
-
-[discrete]
-===== `toArrowTable`
-
-~Added~ ~in~ ~`v8.16.0`~
-
-If you would like to pull the entire data set in Arrow format but without streaming, you can use the `toArrowTable` helper to get a https://arrow.apache.org/docs/js/classes/Arrow_dom.Table.html[Table] back instead.
-
-[source,ts]
-----
-const table = await client.helpers
-  .esql({ query: 'FROM sample_data' })
-  .toArrowTable()
-
-console.log(table.toArray())
-----

docs/index.asciidoc

@@ -1,24 +0,0 @@
-= Elasticsearch JavaScript Client
-
-include::{asciidoc-dir}/../../shared/versions/stack/{source_branch}.asciidoc[]
-include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
-
-include::introduction.asciidoc[]
-include::getting-started.asciidoc[]
-include::changelog.asciidoc[]
-include::installation.asciidoc[]
-include::connecting.asciidoc[]
-include::configuration.asciidoc[]
-include::basic-config.asciidoc[]
-include::advanced-config.asciidoc[]
-include::child.asciidoc[]
-include::testing.asciidoc[]
-include::integrations.asciidoc[]
-include::observability.asciidoc[]
-include::transport.asciidoc[]
-include::typescript.asciidoc[]
-include::reference.asciidoc[]
-include::examples/index.asciidoc[]
-include::helpers.asciidoc[]
-include::redirects.asciidoc[]
-include::timeout-best-practices.asciidoc[]

docs/installation.asciidoc

@@ -1,116 +0,0 @@
-[[installation]]
-== Installation
-
-This page guides you through the installation process of the client.
-
-To install the latest version of the client, run the following command:
-
-[source,sh]
-----
-npm install @elastic/elasticsearch
-----
-
-To install a specific major version of the client, run the following command:
-
-[source,sh]
-----
-npm install @elastic/elasticsearch@<major>
-----
-
-To learn more about the supported major versions, please refer to the
-<<js-compatibility-matrix>>.
-
-[discrete]
-[[nodejs-support]]
-=== Node.js support
-
-NOTE: The minimum supported version of Node.js is `v18`.
-
-The client versioning follows the {stack} versioning, this means that
-major, minor, and patch releases are done following a precise schedule that
-often does not coincide with the https://nodejs.org/en/about/releases/[Node.js release] times.
-
-To avoid support insecure and unsupported versions of Node.js, the
-client *will drop the support of EOL versions of Node.js between minor releases*.
-Typically, as soon as a Node.js version goes into EOL, the client will continue
-to support that version for at least another minor release. If you are using the client
-with a version of Node.js that will be unsupported soon, you will see a warning
-in your logs (the client will start logging the warning with two minors in advance).
-
-Unless you are *always* using a supported version of Node.js,
-we recommend defining the client dependency in your
-`package.json` with the `~` instead of `^`. In this way, you will lock the
-dependency on the minor release and not the major. (for example, `~7.10.0` instead
-of `^7.10.0`).
-
-[%header,cols=3*]
-|===
-|Node.js Version
-|Node.js EOL date
-|End of support
-
-|`8.x`
-|December 2019
-|`7.11` (early 2021)
-
-|`10.x`
-|April 2021
-|`7.12` (mid 2021)
-
-|`12.x`
-|April 2022
-|`8.2` (early 2022)
-
-|`14.x`
-|April 2023
-|`8.8` (early 2023)
-
-|`16.x`
-|September 2023
-|`8.11` (late 2023)
-|===
-
-[discrete]
-[[js-compatibility-matrix]]
-=== Compatibility matrix
-
-Language clients are forward compatible; meaning that clients support
-communicating with greater or equal minor versions of {es} without breaking. It
-does not mean that the client automatically supports new features of newer {es} 
-versions; it is only possible after a release of a new client version. For
-example, a 8.12 client version won't automatically support the new features of
-the 8.13 version of {es}, the 8.13 client version is required for that.
-{es} language clients are only backwards compatible with default distributions
-and without guarantees made.
-
-[%header,cols=3*]
-|===
-|{es} Version
-|Client Version
-|Supported
-
-|`8.x`
-|`8.x`
-|`8.x`
-
-|`7.x`
-|`7.x`
-|`7.17`
-
-|`6.x`
-|`6.x`
-|
-
-|`5.x`
-|`5.x`
-|
-|===
-
-
-[discrete]
-==== Browser
-
-WARNING: There is no official support for the browser environment. It exposes
-your {es} instance to everyone, which could lead to security issues. We
-recommend you to write a lightweight proxy that uses this client instead,
-you can see a proxy example https://github.com/elastic/elasticsearch-js/tree/master/docs/examples/proxy[here].

docs/integrations.asciidoc

@@ -1,8 +0,0 @@
-[[integrations]]
-== Integrations
-
-The Client offers the following integration options for you:
-
-* <<observability>>
-* <<transport>>
-* <<typescript>>

docs/redirects.asciidoc

@@ -1,17 +0,0 @@
-["appendix",role="exclude",id="redirects"]
-= Deleted pages
-
-The following pages have moved or been deleted.
-
-[role="exclude",id="auth-reference"]
-== Authentication
-
-This page has moved. See <<client-connecting>>.
-
-[role="exclude",id="breaking-changes"]
-== Breaking changes
-
-For information about migrating from the legacy elasticsearch.js client to the
-new Elasticsearch JavaScript client, refer to the
-https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/7.17/breaking-changes.html[7.17
-JavaScript client migration guide].

docs/reference/advanced-config.md

@@ -1,25 +1,27 @@
-[[advanced-config]]
-=== Advanced configuration
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/advanced-config.html
+---
 
-If you need to customize the client behavior heavily, you are in the right 
-place! The client enables you to customize the following internals:
+# Advanced configuration [advanced-config]
+
+If you need to customize the client behavior heavily, you are in the right place! The client enables you to customize the following internals:
 
 * `ConnectionPool` class
 * `Connection` class
 * `Serializer` class
 
-NOTE: For information about the `Transport` class, refer to <<transport>>.
+::::{note}
+For information about the `Transport` class, refer to [Transport](/reference/transport.md).
+::::
 
 
-[discrete]
-==== `ConnectionPool`
 
-This class is responsible for keeping in memory all the {es} Connection that you 
-are using. There is a single Connection for every node. The connection pool 
-handles the resurrection strategies and the updates of the pool.
+## `ConnectionPool` [_connectionpool]
 
-[source,js]
-----
+This class is responsible for keeping in memory all the {{es}} Connection that you are using. There is a single Connection for every node. The connection pool handles the resurrection strategies and the updates of the pool.
+
+```js
 const { Client, ConnectionPool } = require('@elastic/elasticsearch')
 
 class MyConnectionPool extends ConnectionPool {
@@ -34,19 +36,14 @@ const client = new Client({
   cloud: { id: '<cloud-id>' },
   auth: { apiKey: 'base64EncodedKey' }
 })
-----
+```
 
 
-[discrete]
-==== `Connection`
+## `Connection` [_connection]
 
-This class represents a single node, it holds every information we have on the 
-node, such as roles, id, URL, custom headers and so on. The actual HTTP request 
-is performed here, this means that if you want to swap the default HTTP client 
-(Node.js core), you should override the `request` method of this class.
+This class represents a single node, it holds every information we have on the node, such as roles, id, URL, custom headers and so on. The actual HTTP request is performed here, this means that if you want to swap the default HTTP client (Node.js core), you should override the `request` method of this class.
 
-[source,js]
-----
+```js
 const { Client, BaseConnection } = require('@elastic/elasticsearch')
 
 class MyConnection extends BaseConnection {
@@ -60,22 +57,19 @@ const client = new Client({
   cloud: { id: '<cloud-id>' },
   auth: { apiKey: 'base64EncodedKey' }
 })
-----
+```
 
 
-[discrete]
-==== `Serializer`
+## `Serializer` [_serializer]
 
-This class is responsible for the serialization of every request, it offers the 
-following methods:
+This class is responsible for the serialization of every request, it offers the following methods:
 
 * `serialize(object: any): string;` serializes request objects.
 * `deserialize(json: string): any;` deserializes response strings.
 * `ndserialize(array: any[]): string;` serializes bulk request objects.
 * `qserialize(object: any): string;` serializes request query parameters.
 
-[source,js]
-----
+```js
 const { Client, Serializer } = require('@elastic/elasticsearch')
 
 class MySerializer extends Serializer {
@@ -89,11 +83,10 @@ const client = new Client({
   cloud: { id: '<cloud-id>' },
   auth: { apiKey: 'base64EncodedKey' }
 })
-----
+```
 
-[discrete]
-[[redaction]]
-==== Redaction of potentially sensitive data
+
+## Redaction of potentially sensitive data [redaction]
 
 When the client raises an `Error` that originated at the HTTP layer, like a `ConnectionError` or `TimeoutError`, a `meta` object is often attached to the error object that includes metadata useful for debugging, like request and response information. Because this can include potentially sensitive data, like authentication secrets in an `Authorization` header, the client takes measures to redact common sources of sensitive data when this metadata is attached and serialized.
 
@@ -101,8 +94,7 @@ If your configuration requires extra headers or other configurations that may in
 
 By default, the `redaction` option is set to `{ type: 'replace' }`, which recursively searches for sensitive key names, case insensitive, and replaces their values with the string `[redacted]`.
 
-[source,js]
-----
+```js
 const { Client } = require('@elastic/elasticsearch')
 
 const client = new Client({
@@ -115,12 +107,11 @@ try {
 } catch (err) {
   console.log(err.meta.meta.request.options.headers.authorization) // prints "[redacted]"
 }
-----
+```
 
 If you would like to redact additional properties, you can include additional key names to search and replace:
 
-[source,js]
-----
+```js
 const { Client } = require('@elastic/elasticsearch')
 
 const client = new Client({
@@ -138,12 +129,11 @@ try {
 } catch (err) {
   console.log(err.meta.meta.request.options.headers['X-My-Secret-Password']) // prints "[redacted]"
 }
-----
+```
 
-Alternatively, if you know you're not going to use the metadata at all, setting the redaction type to `remove` will remove all optional sources of potentially sensitive data entirely, or replacing them with `null` for required properties.
+Alternatively, if you know you’re not going to use the metadata at all, setting the redaction type to `remove` will remove all optional sources of potentially sensitive data entirely, or replacing them with `null` for required properties.
 
-[source,js]
-----
+```js
 const { Client } = require('@elastic/elasticsearch')
 
 const client = new Client({
@@ -157,14 +147,16 @@ try {
 } catch (err) {
   console.log(err.meta.meta.request.options.headers) // undefined
 }
-----
+```
 
 Finally, if you prefer to turn off redaction altogether, perhaps while debugging on a local developer environment, you can set the redaction type to `off`. This will revert the client to pre-8.11.0 behavior, where basic redaction is only performed during common serialization methods like `console.log` and `JSON.stringify`.
 
-WARNING: Setting `redaction.type` to `off` is not recommended in production environments.
+::::{warning}
+Setting `redaction.type` to `off` is not recommended in production environments.
+::::
 
-[source,js]
-----
+
+```js
 const { Client } = require('@elastic/elasticsearch')
 
 const client = new Client({
@@ -178,18 +170,10 @@ try {
 } catch (err) {
   console.log(err.meta.meta.request.options.headers.authorization) // the actual header value will be logged
 }
-----
+```
 
-[discrete]
-==== Migrate to v8
 
-The Node.js client can be configured to emit an HTTP header
-`Accept: application/vnd.elasticsearch+json; compatible-with=7`
-which signals to Elasticsearch that the client is requesting
-`7.x` version of request and response bodies. This allows for
-upgrading from 7.x to 8.x version of Elasticsearch without upgrading
-everything at once. Elasticsearch should be upgraded first after
-the compatibility header is configured and clients should be upgraded
-second.
-To enable to setting, configure the environment variable
-`ELASTIC_CLIENT_APIVERSIONING` to `true`.
+## Migrate to v8 [_migrate_to_v8]
+
+The Node.js client can be configured to emit an HTTP header `Accept: application/vnd.elasticsearch+json; compatible-with=7` which signals to Elasticsearch that the client is requesting `7.x` version of request and response bodies. This allows for upgrading from 7.x to 8.x version of Elasticsearch without upgrading everything at once. Elasticsearch should be upgraded first after the compatibility header is configured and clients should be upgraded second. To enable to setting, configure the environment variable `ELASTIC_CLIENT_APIVERSIONING` to `true`.
+

docs/reference/as_stream_examples.md

@@ -1,11 +1,13 @@
-[[as_stream_examples]]
-=== asStream
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/as_stream_examples.html
+---
 
-Instead of getting the parsed body back, you will get the raw Node.js stream of
-data.
+# asStream [as_stream_examples]
 
-[source,js]
-----
+Instead of getting the parsed body back, you will get the raw Node.js stream of data.
+
+```js
 'use strict'
 
 const { Client } = require('@elastic/elasticsearch')
@@ -66,13 +68,14 @@ async function run () {
 }
 
 run().catch(console.log)
-----
+```
 
-TIP: This can be useful if you need to pipe the {es}'s response to a proxy, or
-send it directly to another source.
+::::{tip}
+This can be useful if you need to pipe the {{es}}'s response to a proxy, or send it directly to another source.
+::::
 
-[source,js]
-----
+
+```js
 'use strict'
 
 const { Client } = require('@elastic/elasticsearch')
@@ -96,4 +99,5 @@ fastify.post('/search/:index', async (req, reply) => {
 })
 
 fastify.listen(3000)
-----
+```
+

docs/reference/basic-config.md

@@ -0,0 +1,368 @@
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/basic-config.html
+---
+
+# Basic configuration [basic-config]
+
+This page explains the basic configuration options for the JavaScript client.
+
+```js
+const { Client } = require('@elastic/elasticsearch')
+
+const client = new Client({
+  cloud: { id: '<cloud-id>' },
+  auth: { apiKey: 'base64EncodedKey' },
+  maxRetries: 5,
+  sniffOnStart: true
+})
+```
+
+### `node` or `nodes`
+
+The {{es}} endpoint to use. It can be a single string or an array of strings:
+
+```js
+node: 'http://localhost:9200'
+```
+
+```js
+nodes: ['http://localhost:9200', 'http://localhost:9201']
+```
+
+Or it can be an object (or an array of objects) that represents the node:
+
+```js
+node: {
+  url: new URL('http://localhost:9200'),
+  tls: 'tls options',
+  agent: 'http agent options',
+  id: 'custom node id',
+  headers: { 'custom': 'headers' },
+  roles: {
+    master: true,
+    data: true,
+    ingest: true,
+    ml: false
+  }
+}
+```
+
+---
+
+### `auth`
+
+Default: `null`
+
+Your authentication data. You can use both basic authentication and [ApiKey](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key).
+ See [Authentication](/reference/connecting.md#authentication) for more details.
+
+Basic authentication:
+
+```js
+auth: {
+  username: 'elastic',
+  password: 'changeme'
+}
+```
+
+[ApiKey](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key) authentication:
+
+```js
+auth: {
+  apiKey: 'base64EncodedKey'
+}
+```
+
+Bearer authentication, useful for [service account tokens](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-service-token). Be aware that it does not handle automatic token refresh:
+
+```js
+auth: {
+  bearer: 'token'
+}
+```
+
+### `maxRetries`
+
+Type: `number`<br>
+Default: `3`
+
+Max number of retries for each request.
+
+### `requestTimeout`
+
+Type: `number`<br>
+Default: `No value`
+
+Max request timeout in milliseconds for each request.
+
+### `pingTimeout`
+
+Type: `number`<br>
+Default: `3000`
+
+Max ping request timeout in milliseconds for each request.
+
+### `sniffInterval`
+
+Type: `number, boolean`<br>
+Default: `false`
+
+Perform a sniff operation every `n` milliseconds.
+
+:::{tip}
+Sniffing might not be the best solution. Before using the various `sniff` options, review this [blog post](https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how).
+:::
+
+### `sniffOnStart`
+
+Type: `boolean`<br>
+Default: `false`
+
+Perform a sniff once the client is started. Be sure to review the sniffing best practices [blog post](https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how).
+
+### `sniffEndpoint`
+
+Type: `string`<br>
+Default: `'_nodes/_all/http'`
+
+Endpoint to ping during a sniff. Be sure to review the sniffing best practices [blog post](https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how).
+
+### `sniffOnConnectionFault`
+
+Type: `boolean`<br>
+Default: `false`
+
+Perform a sniff on connection fault. Be sure to review the sniffing best practices [blog post](https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how).
+
+### `resurrectStrategy`
+
+Type: `string`<br>
+Default: `'ping'`
+
+Configure the node resurrection strategy.<br>
+Options: `'ping'`, `'optimistic'`, `'none'`
+
+### `suggestCompression`
+
+Type: `boolean`<br>
+Default: `false`
+
+Adds an `accept-encoding` header to every request.
+
+### `compression`
+
+Type: `string, boolean`<br>
+Default: `false`
+
+Enables gzip request body compression.<br>
+Options: `'gzip'`, `false`
+
+### `tls`
+
+Type: `http.SecureContextOptions`<br>
+Default: `null`
+
+The [tls configuraton](https://nodejs.org/api/tls.html).
+
+### `proxy`
+
+Type: `string, URL`<br>
+Default: `null`
+
+If you are using an http(s) proxy, you can put its url here. The client will automatically handle the connection to it.
+
+```js
+const client = new Client({
+  node: 'http://localhost:9200',
+  proxy: 'http://localhost:8080'
+})
+
+const client = new Client({
+  node: 'http://localhost:9200',
+  proxy: 'http://user:pwd@localhost:8080'
+})
+```
+
+### `agent`
+
+Type: `http.AgentOptions, function`<br>
+Default: `null`
+
+http agent [options](https://nodejs.org/api/http.html#http_new_agent_options), or a function that returns an actual http agent instance. If you want to disable the http agent use entirely (and disable the `keep-alive` feature), set the agent to `false`.
+
+```js
+const client = new Client({
+  node: 'http://localhost:9200',
+  agent: { agent: 'options' }
+})
+
+const client = new Client({
+  node: 'http://localhost:9200',
+  // the function takes as parameter the option
+  // object passed to the Connection constructor
+  agent: (opts) => new CustomAgent()
+})
+
+const client = new Client({
+  node: 'http://localhost:9200',
+  // Disable agent and keep-alive
+  agent: false
+})
+```
+
+### `nodeFilter`
+
+Type: `function`
+
+Filter that indicates whether a node should be used for a request. Default function definition:
+
+```js
+function defaultNodeFilter (conn) {
+  if (conn.roles != null) {
+    if (
+      // avoid master-only nodes
+      conn.roles.master &&
+      !conn.roles.data &&
+      !conn.roles.ingest &&
+      !conn.roles.ml
+    ) return false
+  }
+  return true
+}
+```
+
+### `nodeSelector`
+
+Type: `function`<br>
+Default: `'round-robin'`
+
+Custom selection strategy.<br>
+Options: `'round-robin'`, `'random'`, custom function
+
+Custom function example:
+
+```js
+function nodeSelector (connections) {
+  const index = calculateIndex()
+  return connections[index]
+}
+```
+
+### `generateRequestId`
+
+Type: `function`<br>
+
+function to generate the request id for every request, it takes two parameters, the request parameters and options. By default, it generates an incremental integer for every request.
+
+Custom function example:
+
+```js
+function generateRequestId (params, options) {
+  // your id generation logic
+  // must be syncronous
+  return 'id'
+}
+```
+
+### `name`
+
+Type: `string, symbol`<br>
+Default: `elasticsearch-js`
+
+The name to identify the client instance in the events.
+
+### `opaqueIdPrefix`
+
+Type: `string`<br>
+Default: `null`
+
+A string that will be use to prefix any `X-Opaque-Id` header.
+See [`X-Opaque-Id` support](/reference/observability.md#_x_opaque_id_support) for more details.
+
+### `headers`
+
+Type: `object`<br>
+Default: `{}`
+
+A set of custom headers to send in every request.
+
+### `context`
+
+Type: `object`<br>
+Default: `null`
+
+A custom object that you can use for observability in your events. It will be merged with the API level context option.
+
+### `enableMetaHeader`
+
+Type: `boolean`<br>
+Default: `true`
+
+If true, adds an header named `'x-elastic-client-meta'`, containing some minimal telemetry data, such as the client and platform version.
+
+### `cloud`
+
+Type: `object`<br>
+Default: `null`
+
+Custom configuration for connecting to [Elastic Cloud](https://cloud.elastic.co). See [Authentication](/reference/connecting.md) for more details.
+
+Cloud configuration example:
+
+```js
+const client = new Client({
+  cloud: {
+    id: '<cloud-id>'
+  },
+  auth: {
+    username: 'elastic',
+    password: 'changeme'
+  }
+})
+```
+
+### `disablePrototypePoisoningProtection`
+
+Default: `true`
+
+`boolean`, `'proto'`, `'constructor'` - The client can protect you against prototype poisoning attacks. For more information, refer to [Square Brackets are the Enemy](https://web.archive.org/web/20200319091159/https://hueniverse.com/square-brackets-are-the-enemy-ff5b9fd8a3e8?gi=184a27ee2a08). If needed, you can enable prototype poisoning protection entirely (`false`) or one of the two checks (`'proto'` or `'constructor'`). For performance reasons, it is disabled by default. To learn more, refer to the [`secure-json-parse` documentation](https://github.com/fastify/secure-json-parse).
+
+### `caFingerprint`
+
+Type: `string`<br>
+Default: `null`
+
+If configured, verify that the fingerprint of the CA certificate that has signed the certificate of the server matches the supplied fingerprint. Only accepts SHA256 digest fingerprints.
+
+### `maxResponseSize`
+
+Type: `number`<br>
+Default: `null`
+
+When configured, `maxResponseSize` verifies that the uncompressed response size is lower than the configured number. If it’s higher, the request will be canceled. The `maxResponseSize` cannot be higher than the value of `buffer.constants.MAX_STRING_LENGTH`.
+
+### `maxCompressedResponseSize`
+
+Type: `number`<br>
+Default: `null`
+
+When configured, `maxCompressedResponseSize` verifies that the compressed response size is lower than the configured number. If it’s higher, the request will be canceled. The `maxCompressedResponseSize` cannot be higher than the value of `buffer.constants.MAX_STRING_LENGTH`.
+
+### `redaction`
+
+Type: `object`<br>
+Default: A configuration that will replace known sources of sensitive data in `Error` metadata
+
+Options for how to redact potentially sensitive data from metadata attached to `Error` objects
+
+::::{note}
+[Read about redaction](/reference/advanced-config.md#redaction) for more details
+::::
+
+### `serverMode`
+
+Type: `string`<br>
+Default: `"stack"`
+
+Setting to `"stack"` sets defaults assuming a traditional (non-serverless) {{es}} instance. Setting to `"serverless"` sets defaults to work more seamlessly with [Elastic Cloud Serverless](https://www.elastic.co/guide/en/serverless/current/intro.html), like enabling compression and disabling features that assume the possibility of multiple {{es}} nodes.

docs/reference/bulk_examples.md

@@ -1,13 +1,18 @@
-[[bulk_examples]]
-=== Bulk
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/bulk_examples.html
+---
 
-With the {jsclient}/api-reference.html#_bulk[`bulk` API], you can perform multiple index/delete operations in a 
-single API call. The `bulk` API significantly increases indexing speed.
+# Bulk [bulk_examples]
 
-NOTE: You can also use the {jsclient}/client-helpers.html[bulk helper].
+With the [`bulk` API](/reference/api-reference.md#_bulk), you can perform multiple index/delete operations in a single API call. The `bulk` API significantly increases indexing speed.
 
-[source,js]
-----
+::::{note}
+You can also use the [bulk helper](/reference/client-helpers.md#bulk-helper).
+::::
+
+
+```js
 'use strict'
 
 require('array.prototype.flatmap').shim()
@@ -90,4 +95,5 @@ async function run () {
 }
 
 run().catch(console.log)
-----
+```
+

docs/reference/child.md

@@ -0,0 +1,34 @@
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/child.html
+---
+
+# Creating a child client [child]
+
+There are some use cases where you may need multiple instances of the client. You can easily do that by calling `new Client()` as many times as you need, but you will lose all the benefits of using one single client, such as the long living connections and the connection pool handling. To avoid this problem, the client offers a `child` API, which returns a new client instance that shares the connection pool with the parent client.
+
+::::{note}
+The event emitter is shared between the parent and the child(ren). If you extend the parent client, the child client will have the same extensions, while if the child client adds an extension, the parent client will not be extended.
+::::
+
+
+You can pass to the `child` every client option you would pass to a normal client, but the connection pool specific options (`ssl`, `agent`, `pingTimeout`, `Connection`, and `resurrectStrategy`).
+
+::::{warning}
+If you call `close` in any of the parent/child clients, every client will be closed.
+::::
+
+
+```js
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  cloud: { id: '<cloud-id>' },
+  auth: { apiKey: 'base64EncodedKey' }
+})
+const child = client.child({
+  headers: { 'x-foo': 'bar' },
+})
+
+client.info().then(console.log, console.log)
+child.info().then(console.log, console.log)
+```

docs/reference/client-helpers.md

@@ -0,0 +1,648 @@
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-helpers.html
+---
+
+# Client helpers [client-helpers]
+
+The client comes with an handy collection of helpers to give you a more comfortable experience with some APIs.
+
+::::{warning}
+The client helpers are experimental, and the API may change in the next minor releases. The helpers will not work in any Node.js version lower than 10.
+::::
+
+## Bulk helper [bulk-helper]
+
+Added in `v7.7.0`
+
+Running bulk requests can be complex due to the shape of the API, this helper aims to provide a nicer developer experience around the Bulk API.
+
+### Usage [_usage_3]
+
+```js
+const { createReadStream } = require('fs')
+const split = require('split2')
+const { Client } = require('@elastic/elasticsearch')
+
+const client = new Client({
+  cloud: { id: '<cloud-id>' },
+  auth: { apiKey: 'base64EncodedKey' }
+})
+const result = await client.helpers.bulk({
+  datasource: createReadStream('./dataset.ndjson').pipe(split()),
+  onDocument (doc) {
+    return {
+      index: { _index: 'my-index' }
+    }
+  }
+})
+
+console.log(result)
+// {
+//   total: number,
+//   failed: number,
+//   retry: number,
+//   successful: number,
+//   time: number,
+//   bytes: number,
+//   aborted: boolean
+// }
+```
+
+To create a new instance of the Bulk helper, access it as shown in the example above, the configuration options are:
+
+`datasource`
+:   An array, async generator or a readable stream with the data you need to index/create/update/delete. It can be an array of strings or objects, but also a stream of json strings or JavaScript objects.
+    If it is a stream, we recommend to use the [`split2`](https://www.npmjs.com/package/split2) package, that splits the stream on new lines delimiters.
+    This parameter is mandatory.
+
+    ```js
+    const { createReadStream } = require('fs')
+    const split = require('split2')
+    const b = client.helpers.bulk({
+      // if you just use split(), the data will be used as array of strings
+      datasource: createReadStream('./dataset.ndjson').pipe(split())
+      // if you need to manipulate the data, you can pass JSON.parse to split
+      datasource: createReadStream('./dataset.ndjson').pipe(split(JSON.parse))
+    })
+    ```
+
+`onDocument`
+:   A function that is called for each document of the datasource. Inside this function you can manipulate the document and you must return the operation you want to execute with the document. Look at the [Bulk API documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk) to see the supported operations.
+    This parameter is mandatory.
+
+    ```js
+    const b = client.helpers.bulk({
+      onDocument (doc) {
+        return {
+          index: { _index: 'my-index' }
+        }
+      }
+    })
+    ```
+
+`onDrop`
+:   A function that is called for everytime a document can’t be indexed and it has reached the maximum amount of retries.
+
+    ```js
+    const b = client.helpers.bulk({
+      onDrop (doc) {
+        console.log(doc)
+      }
+    })
+    ```
+
+`onSuccess`
+:   A function that is called for each successful operation in the bulk request, which includes the result from Elasticsearch along with the original document that was sent, or `null` for delete operations.
+
+    ```js
+    const b = client.helpers.bulk({
+      onSuccess ({ result, document }) {
+        console.log(`SUCCESS: Document ${result.index._id} indexed to ${result.index._index}`)
+      }
+    })
+    ```
+
+`flushBytes`
+:   The size of the bulk body in bytes to reach before to send it. Default of 5MB.
+    *Default:* `5000000`
+
+    ```js
+    const b = client.helpers.bulk({
+      flushBytes: 1000000
+    })
+    ```
+
+`flushInterval`
+:   How much time (in milliseconds) the helper waits before flushing the body from the last document read.
+    *Default:* `30000`
+
+    ```js
+    const b = client.helpers.bulk({
+      flushInterval: 30000
+    })
+    ```
+
+`concurrency`
+:   How many request is executed at the same time.
+    *Default:* `5`
+
+    ```js
+    const b = client.helpers.bulk({
+      concurrency: 10
+    })
+    ```
+
+`retries`
+:   How many times a document is retried before to call the `onDrop` callback.
+    *Default:* Client max retries.
+
+    ```js
+    const b = client.helpers.bulk({
+      retries: 3
+    })
+    ```
+
+`wait`
+:   How much time to wait before retries in milliseconds.
+    *Default:* 5000.
+
+    ```js
+    const b = client.helpers.bulk({
+      wait: 3000
+    })
+    ```
+
+`refreshOnCompletion`
+:   If `true`, at the end of the bulk operation it runs a refresh on all indices or on the specified indices.
+    *Default:* false.
+
+    ```js
+    const b = client.helpers.bulk({
+      refreshOnCompletion: true
+      // or
+      refreshOnCompletion: 'index-name'
+    })
+    ```
+
+### Supported operations [_supported_operations]
+
+#### Index [_index_2]
+
+```js
+client.helpers.bulk({
+  datasource: myDatasource,
+  onDocument (doc) {
+    return {
+      index: { _index: 'my-index' }
+    }
+  }
+})
+```
+
+#### Create [_create_4]
+
+```js
+client.helpers.bulk({
+  datasource: myDatasource,
+  onDocument (doc) {
+    return {
+      create: { _index: 'my-index', _id: doc.id }
+    }
+  }
+})
+```
+
+#### Update [_update_3]
+
+```js
+client.helpers.bulk({
+  datasource: myDatasource,
+  onDocument (doc) {
+    // Note that the update operation requires you to return
+    // an array, where the first element is the action, while
+    // the second are the document option
+    return [
+      { update: { _index: 'my-index', _id: doc.id } },
+      { doc_as_upsert: true }
+    ]
+  }
+})
+```
+
+#### Delete [_delete_10]
+
+```js
+client.helpers.bulk({
+  datasource: myDatasource,
+  onDocument (doc) {
+    return {
+      delete: { _index: 'my-index', _id: doc.id }
+    }
+  }
+})
+```
+
+### Abort a bulk operation [_abort_a_bulk_operation]
+
+If needed, you can abort a bulk operation at any time. The bulk helper returns a [thenable](https://promisesaplus.com/), which has an `abort` method.
+
+::::{note}
+The abort method stops the execution of the bulk operation, but if you are using a concurrency higher than one, the operations that are already running will not be stopped.
+::::
+
+```js
+const { createReadStream } = require('fs')
+const split = require('split2')
+const { Client } = require('@elastic/elasticsearch')
+
+const client = new Client({
+  cloud: { id: '<cloud-id>' },
+  auth: { apiKey: 'base64EncodedKey' }
+})
+const b = client.helpers.bulk({
+  datasource: createReadStream('./dataset.ndjson').pipe(split()),
+  onDocument (doc) {
+    return {
+      index: { _index: 'my-index' }
+    }
+  },
+  onDrop (doc) {
+    b.abort()
+  }
+})
+
+console.log(await b)
+```
+
+### Passing custom options to the Bulk API [_passing_custom_options_to_the_bulk_api]
+
+You can pass any option supported by the link: [Bulk API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk) to the helper, and the helper uses those options in conjunction with the Bulk API call.
+
+```js
+const result = await client.helpers.bulk({
+  datasource: [...],
+  onDocument (doc) {
+    return {
+      index: { _index: 'my-index' }
+    }
+  },
+  pipeline: 'my-pipeline'
+})
+```
+
+### Usage with an async generator [_usage_with_an_async_generator]
+
+```js
+const { Client } = require('@elastic/elasticsearch')
+
+async function * generator () {
+  const dataset = [
+    { user: 'jon', age: 23 },
+    { user: 'arya', age: 18 },
+    { user: 'tyrion', age: 39 }
+  ]
+  for (const doc of dataset) {
+    yield doc
+  }
+}
+
+const client = new Client({
+  cloud: { id: '<cloud-id>' },
+  auth: { apiKey: 'base64EncodedKey' }
+})
+const result = await client.helpers.bulk({
+  datasource: generator(),
+  onDocument (doc) {
+    return {
+      index: { _index: 'my-index' }
+    }
+  }
+})
+
+console.log(result)
+```
+
+### Modifying a document before operation [_modifying_a_document_before_operation]
+
+Added in `v8.8.2`
+
+If you need to modify documents in your datasource before it is sent to Elasticsearch, you can return an array in the `onDocument` function rather than an operation object. The first item in the array must be the operation object, and the second item must be the document or partial document object as you’d like it to be sent to Elasticsearch.
+
+```js
+const { Client } = require('@elastic/elasticsearch')
+
+const client = new Client({
+  cloud: { id: '<cloud-id>' },
+  auth: { apiKey: 'base64EncodedKey' }
+})
+const result = await client.helpers.bulk({
+  datasource: [...],
+  onDocument (doc) {
+    return [
+      { index: { _index: 'my-index' } },
+      { ...doc, favorite_color: 'mauve' },
+    ]
+  }
+})
+
+console.log(result)
+```
+
+## Multi search helper [multi-search-helper]
+
+Added in `v7.8.0`
+
+If you send search request at a high rate, this helper might be useful for you. It uses the multi search API under the hood to batch the requests and improve the overall performances of your application. The `result` exposes a `documents` property as well, which allows you to access directly the hits sources.
+
+### Usage [_usage_4]
+
+```js
+const { Client } = require('@elastic/elasticsearch')
+
+const client = new Client({
+  cloud: { id: '<cloud-id>' },
+  auth: { apiKey: 'base64EncodedKey' }
+})
+const m = client.helpers.msearch()
+
+m.search(
+    { index: 'stackoverflow' },
+    { query: { match: { title: 'javascript' } } }
+  )
+  .then(result => console.log(result.body)) // or result.documents
+  .catch(err => console.error(err))
+```
+
+To create a new instance of the multi search (msearch) helper, you should access it as shown in the example above, the configuration options are:
+
+`operations`
+:   How many search operations should be sent in a single msearch request.
+    *Default:* `5`
+
+    ```js
+    const m = client.helpers.msearch({
+      operations: 10
+    })
+    ```
+
+`flushInterval`
+:   How much time (in milliseconds) the helper waits before flushing the operations from the last operation read.
+    *Default:* `500`
+
+    ```js
+    const m = client.helpers.msearch({
+      flushInterval: 500
+    })
+    ```
+
+`concurrency`
+:   How many request is executed at the same time.
+    *Default:* `5`
+
+    ```js
+    const m = client.helpers.msearch({
+      concurrency: 10
+    })
+    ```
+
+`retries`
+:   How many times an operation is retried before to resolve the request. An operation is retried only in case of a 429 error.
+    *Default:* Client max retries.
+
+    ```js
+    const m = client.helpers.msearch({
+      retries: 3
+    })
+    ```
+
+`wait`
+:   How much time to wait before retries in milliseconds.
+    *Default:* 5000.
+
+    ```js
+    const m = client.helpers.msearch({
+      wait: 3000
+    })
+    ```
+
+### Stopping the msearch helper [_stopping_the_msearch_helper]
+
+If needed, you can stop an msearch processor at any time. The msearch helper returns a [thenable](https://promisesaplus.com/), which has an `stop` method.
+
+If you are creating multiple msearch helpers instances and using them for a limitied period of time, remember to always use the `stop` method once you have finished using them, otherwise your application will start leaking memory.
+
+The `stop` method accepts an optional error, that will be dispatched every subsequent search request.
+
+::::{note}
+The stop method stops the execution of the msearch processor, but if you are using a concurrency higher than one, the operations that are already running will not be stopped.
+::::
+
+```js
+const { Client } = require('@elastic/elasticsearch')
+
+const client = new Client({
+  cloud: { id: '<cloud-id>' },
+  auth: { apiKey: 'base64EncodedKey' }
+})
+const m = client.helpers.msearch()
+
+m.search(
+    { index: 'stackoverflow' },
+    { query: { match: { title: 'javascript' } } }
+  )
+  .then(result => console.log(result.body))
+  .catch(err => console.error(err))
+
+m.search(
+    { index: 'stackoverflow' },
+    { query: { match: { title: 'ruby' } } }
+  )
+  .then(result => console.log(result.body))
+  .catch(err => console.error(err))
+
+setImmediate(() => m.stop())
+```
+
+## Search helper [search-helper]
+
+Added in `v7.7.0`
+
+A simple wrapper around the search API. Instead of returning the entire `result` object it returns only the search documents source. For improving the performances, this helper automatically adds `filter_path=hits.hits._source` to the query string.
+
+```js
+const documents = await client.helpers.search({
+  index: 'stackoverflow',
+  query: {
+    match: {
+      title: 'javascript'
+    }
+  }
+})
+
+for (const doc of documents) {
+  console.log(doc)
+}
+```
+
+## Scroll search helper [scroll-search-helper]
+
+Added in `v7.7.0`
+
+This helpers offers a simple and intuitive way to use the scroll search API. Once called, it returns an [async iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function) which can be used in conjuction with a for-await…​of. It handles automatically the `429` error and uses the `maxRetries` option of the client.
+
+```js
+const scrollSearch = client.helpers.scrollSearch({
+  index: 'stackoverflow',
+  query: {
+    match: {
+      title: 'javascript'
+    }
+  }
+})
+
+for await (const result of scrollSearch) {
+  console.log(result)
+}
+```
+
+### Clear a scroll search [_clear_a_scroll_search]
+
+If needed, you can clear a scroll search by calling `result.clear()`:
+
+```js
+for await (const result of scrollSearch) {
+  if (condition) {
+    await result.clear()
+  }
+}
+```
+
+### Quickly getting the documents [_quickly_getting_the_documents]
+
+If you only need the documents from the result of a scroll search, you can access them via `result.documents`:
+
+```js
+for await (const result of scrollSearch) {
+  console.log(result.documents)
+}
+```
+
+## Scroll documents helper [scroll-documents-helper]
+
+Added in `v7.7.0`
+
+It works in the same way as the scroll search helper, but it returns only the documents instead. Note, every loop cycle returns a single document, and you can’t use the `clear` method. For improving the performances, this helper automatically adds `filter_path=hits.hits._source` to the query string.
+
+```js
+const scrollSearch = client.helpers.scrollDocuments({
+  index: 'stackoverflow',
+  query: {
+    match: {
+      title: 'javascript'
+    }
+  }
+})
+
+for await (const doc of scrollSearch) {
+  console.log(doc)
+}
+```
+
+## ES|QL helper [esql-helper]
+
+ES|QL queries can return their results in [several formats](docs-content://explore-analyze/query-filter/languages/esql-rest.md#esql-rest-format). The default JSON format returned by ES|QL queries contains arrays of values for each row, with column names and types returned separately:
+
+### Usage [_usage_5]
+
+#### `toRecords` [_torecords]
+
+Added in `v8.14.0`
+
+The default JSON format returned by ES|QL queries contains arrays of values for each row, with column names and types returned separately:
+
+```json
+{
+  "columns": [
+    { "name": "@timestamp", "type": "date" },
+    { "name": "client_ip", "type": "ip" },
+    { "name": "event_duration", "type": "long" },
+    { "name": "message", "type": "keyword" }
+  ],
+  "values": [
+    [
+      "2023-10-23T12:15:03.360Z",
+      "172.21.2.162",
+      3450233,
+      "Connected to 10.1.0.3"
+    ],
+    [
+      "2023-10-23T12:27:28.948Z",
+      "172.21.2.113",
+      2764889,
+      "Connected to 10.1.0.2"
+    ]
+  ]
+}
+```
+
+In many cases, it’s preferable to operate on an array of objects, one object per row, rather than an array of arrays. The ES|QL `toRecords` helper converts row data into objects.
+
+```js
+await client.helpers
+  .esql({ query: 'FROM sample_data | LIMIT 2' })
+  .toRecords()
+// =>
+// {
+//   "columns": [
+//     { "name": "@timestamp", "type": "date" },
+//     { "name": "client_ip", "type": "ip" },
+//     { "name": "event_duration", "type": "long" },
+//     { "name": "message", "type": "keyword" }
+//   ],
+//   "records": [
+//     {
+//       "@timestamp": "2023-10-23T12:15:03.360Z",
+//       "client_ip": "172.21.2.162",
+//       "event_duration": 3450233,
+//       "message": "Connected to 10.1.0.3"
+//     },
+//     {
+//       "@timestamp": "2023-10-23T12:27:28.948Z",
+//       "client_ip": "172.21.2.113",
+//       "event_duration": 2764889,
+//       "message": "Connected to 10.1.0.2"
+//     },
+//   ]
+// }
+```
+
+In TypeScript, you can declare the type that `toRecords` returns:
+
+```ts
+type EventLog = {
+  '@timestamp': string,
+  client_ip: string,
+  event_duration: number,
+  message: string,
+}
+
+const result = await client.helpers
+  .esql({ query: 'FROM sample_data | LIMIT 2' })
+  .toRecords<EventLog>()
+```
+
+#### `toArrowReader` [_toarrowreader]
+
+Added in `v8.16.0`
+
+ES|QL can return results in multiple binary formats, including [Apache Arrow](https://arrow.apache.org/)'s streaming format. Because it is a very efficient format to read, it can be valuable for performing high-performance in-memory analytics. And, because the response is streamed as batches of records, it can be used to produce aggregations and other calculations on larger-than-memory data sets.
+
+`toArrowReader` returns an [`AsyncRecordBatchStreamReader`](https://github.com/apache/arrow/blob/520ae44272d491bbb52eb3c9b84864ed7088f11a/js/src/ipc/reader.ts#L216).
+
+```ts
+const reader = await client.helpers
+  .esql({ query: 'FROM sample_data' })
+  .toArrowReader()
+
+// print each record as JSON
+for await (const recordBatch of reader) {
+  for (const record of recordBatch) {
+    console.log(record.toJSON())
+  }
+}
+```
+
+#### `toArrowTable` [_toarrowtable]
+
+Added in `v8.16.0`
+
+If you would like to pull the entire data set in Arrow format but without streaming, you can use the `toArrowTable` helper to get a [Table](https://arrow.apache.org/docs/js/classes/Arrow_dom.Table.md) back instead.
+
+```ts
+const table = await client.helpers
+  .esql({ query: 'FROM sample_data' })
+  .toArrowTable()
+
+console.log(table.toArray())
+```

docs/reference/client-testing.md

@@ -0,0 +1,121 @@
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-testing.html
+---
+
+# Testing [client-testing]
+
+Testing is one of the most important parts of developing an application. The client is very flexible when it comes to testing and is compatible with most testing frameworks (such as [`ava`](https://www.npmjs.com/package/ava), which is used in the examples below).
+
+If you are using this client, you are most likely working with {{es}}, and one of the first issues you face is how to test your application. A perfectly valid solution is to use the real {{es}} instance for testing your application, but you would be doing an integration test, while you want a unit test. There are many ways to solve this problem, you could create the database with Docker, or use an in-memory compatible one, but if you are writing unit tests that can be easily parallelized this becomes quite uncomfortable. A different way of improving your testing experience while doing unit tests is to use a mock.
+
+The client is designed to be easy to extend and adapt to your needs. Thanks to its internal architecture it allows you to change some specific components while keeping the rest of it working as usual. Each {{es}} official client is composed of the following components:
+
+* `API layer`: every {{es}} API that you can call.
+* `Transport`: a component that takes care of preparing a request before sending it and handling all the retry and sniffing strategies.
+* `ConnectionPool`: {{es}} is a cluster and might have multiple nodes, the `ConnectionPool` takes care of them.
+* `Serializer`: A class with all the serialization strategies, from the basic JSON to the new line delimited JSON.
+* `Connection`: The actual HTTP library.
+
+The best way to mock {{es}} with the official clients is to replace the `Connection` component since it has very few responsibilities and it does not interact with other internal components other than getting requests and returning responses.
+
+
+## `@elastic/elasticsearch-mock` [_elasticelasticsearch_mock]
+
+Writing each time a mock for your test can be annoying and error-prone, so we have built a simple yet powerful mocking library specifically designed for this client, and you can install it with the following command:
+
+```sh
+npm install @elastic/elasticsearch-mock --save-dev
+```
+
+With this library you can create custom mocks for any request you can send to {{es}}. It offers a simple and intuitive API and it mocks only the HTTP layer, leaving the rest of the client working as usual.
+
+Before showing all of its features, and what you can do with it, let’s see an example:
+
+```js
+const { Client } = require('@elastic/elasticsearch')
+const Mock = require('@elastic/elasticsearch-mock')
+
+const mock = new Mock()
+const client = new Client({
+  cloud: { id: '<cloud-id>' },
+  auth: { apiKey: 'base64EncodedKey' },
+  Connection: mock.getConnection()
+})
+
+mock.add({
+  method: 'GET',
+  path: '/'
+}, () => {
+  return { status: 'ok' }
+})
+
+client.info().then(console.log, console.log)
+```
+
+As you can see it works closely with the client itself, once you have created a new instance of the mock library you just need to call the mock.getConnection() method and pass its result to the Connection option of the client. From now on, every request is handled by the mock library,  and the HTTP layer will never be touched. As a result, your test is significantly faster and you are able to easily parallelize them!
+
+The library allows you to write both “strict” and “loose” mocks, which means that you can write a mock that handles a very specific request or be looser and handle a group of request, let’s see this in action:
+
+```js
+mock.add({
+  method: 'POST',
+  path: '/indexName/_search'
+}, () => {
+  return {
+    hits: {
+      total: { value: 1, relation: 'eq' },
+      hits: [{ _source: { baz: 'faz' } }]
+    }
+  }
+})
+
+mock.add({
+  method: 'POST',
+  path: '/indexName/_search',
+  body: { query: { match: { foo: 'bar' } } }
+}, () => {
+  return {
+    hits: {
+      total: { value: 0, relation: 'eq' },
+      hits: []
+    }
+  }
+})
+```
+
+In the example above, every search request gets the first response, while every search request that uses the query described in the second mock gets the second response.
+
+You can also specify dynamic paths:
+
+```js
+mock.add({
+  method: 'GET',
+  path: '/:index/_count'
+}, () => {
+  return { count: 42 }
+})
+
+client.count({ index: 'foo' }).then(console.log, console.log) // => { count: 42 }
+client.count({ index: 'bar' }).then(console.log, console.log) // => { count: 42 }
+```
+
+And wildcards are supported as well.
+
+Another very interesting use case is the ability to create a test that randomly fails to see how your code reacts to failures:
+
+```js
+mock.add({
+  method: 'GET',
+  path: '/:index/_count'
+}, () => {
+  if (Math.random() > 0.8) {
+    return ResponseError({ body: {}, statusCode: 500 })
+  } else {
+    return { count: 42 }
+  }
+})
+```
+
+We have seen how simple is mocking {{es}} and testing your application, you can find many more features and examples in the [module documentation](https://github.com/elastic/elasticsearch-js-mock).
+

docs/reference/configuration.md

@@ -0,0 +1,14 @@
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-configuration.html
+---
+
+# Configuration [client-configuration]
+
+The client is designed to be easily configured for your needs. In the following section, you can see the possible options that you can use to configure it.
+
+- [Basic configuration](/reference/basic-config.md)
+- [Advanced configuration](/reference/advanced-config.md)
+- [Timeout best practices](/reference/timeout-best-practices.md)
+- [Creating a child client](/reference/child.md)
+- [Testing](/reference/client-testing.md)

docs/reference/connecting.md

@@ -0,0 +1,516 @@
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-connecting.html
+---
+
+# Connecting [client-connecting]
+
+This page contains the information you need to connect and use the Client with {{es}}.
+
+## Authentication [authentication]
+
+This document contains code snippets to show you how to connect to various {{es}} providers.
+
+### Elastic Cloud [auth-ec]
+
+If you are using [Elastic Cloud](https://www.elastic.co/cloud), the client offers an easy way to connect to it via the `cloud` option. You must pass the Cloud ID that you can find in the cloud console, then your username and password inside the `auth` option.
+
+::::{note}
+When connecting to Elastic Cloud, the client will automatically enable both request and response compression by default, since it yields significant throughput improvements. Moreover, the client will also set the tls option `secureProtocol` to `TLSv1_2_method` unless specified otherwise. You can still override this option by configuring them.
+::::
+
+::::{important}
+Do not enable sniffing when using Elastic Cloud, since the nodes are behind a load balancer, Elastic Cloud will take care of everything for you. Take a look [here](https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how) to know more.
+::::
+
+```js
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  cloud: {
+    id: '<cloud-id>'
+  },
+  auth: {
+    username: 'elastic',
+    password: 'changeme'
+  }
+})
+```
+
+## Connecting to an Elastic Cloud Serverless instance [connect-serverless]
+
+The Node.js client is built to support connecting to [Elastic Cloud Serverless](https://www.elastic.co/guide/en/serverless/current/intro.html). By setting the `serverMode` option to `"serverless"`, several default options will be modified to better suit the serverless environment.
+
+```js
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  cloud: {
+    id: '<cloud-id>'
+  },
+  auth: {
+    username: 'elastic',
+    password: 'changeme'
+  },
+  serverMode: 'serverless'
+})
+
+```
+
+## Connecting to a self-managed cluster [connect-self-managed-new]
+
+By default {{es}} will start with security features like authentication and TLS enabled. To connect to the {{es}} cluster you’ll need to configure the Node.js {{es}} client to use HTTPS with the generated CA certificate in order to make requests successfully.
+
+If you’re just getting started with {{es}} we recommend reading the documentation on [configuring](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md) and [starting {{es}}](docs-content://deploy-manage/maintenance/start-stop-services/start-stop-elasticsearch.md) to ensure your cluster is running as expected.
+
+When you start {{es}} for the first time you’ll see a distinct block like the one below in the output from {{es}} (you may have to scroll up if it’s been a while):
+
+```sh
+-> Elasticsearch security features have been automatically configured!
+-> Authentication is enabled and cluster connections are encrypted.
+
+->  Password for the elastic user (reset with `bin/elasticsearch-reset-password -u elastic`):
+  lhQpLELkjkrawaBoaz0Q
+
+->  HTTP CA certificate SHA-256 fingerprint:
+  a52dd93511e8c6045e21f16654b77c9ee0f34aea26d9f40320b531c474676228
+...
+```
+
+Depending on the circumstances there are two options for verifying the HTTPS connection, either verifying with the CA certificate itself or via the HTTP CA certificate fingerprint.
+
+### TLS configuration [auth-tls]
+
+The generated root CA certificate can be found in the `certs` directory in your {{es}} config location (`$ES_CONF_PATH/certs/http_ca.crt`). If you’re running {{es}} in Docker there is [additional documentation for retrieving the CA certificate](docs-content://deploy-manage/deploy/self-managed/install-elasticsearch-with-docker.md).
+
+Without any additional configuration you can specify `https://` node urls, and the certificates used to sign these requests will be verified. To turn off certificate verification, you must specify an `tls` object in the top level config and set `rejectUnauthorized: false`. The default `tls` values are the same that Node.js’s [`tls.connect()`](https://nodejs.org/api/tls.md#tls_tls_connect_options_callback) uses.
+
+```js
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  node: 'https://localhost:9200',
+  auth: {
+    username: 'elastic',
+    password: 'changeme'
+  },
+  tls: {
+    ca: fs.readFileSync('./http_ca.crt'),
+    rejectUnauthorized: false
+  }
+})
+```
+
+### CA fingerprint [auth-ca-fingerprint]
+
+You can configure the client to only trust certificates that are signed by a specific CA certificate (CA certificate pinning) by providing a `caFingerprint` option. This will verify that the fingerprint of the CA certificate that has signed the certificate of the server matches the supplied value. You must configure a SHA256 digest.
+
+```js
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  node: 'https://example.com'
+  auth: { ... },
+  // the fingerprint (SHA256) of the CA certificate that is used to sign
+  // the certificate that the Elasticsearch node presents for TLS.
+  caFingerprint: '20:0D:CA:FA:76:...',
+  tls: {
+    // might be required if it's a self-signed certificate
+    rejectUnauthorized: false
+  }
+})
+```
+
+The certificate fingerprint can be calculated using `openssl x509` with the certificate file:
+
+```sh
+openssl x509 -fingerprint -sha256 -noout -in /path/to/http_ca.crt
+```
+
+If you don’t have access to the generated CA file from {{es}} you can use the following script to output the root CA fingerprint of the {{es}} instance with `openssl s_client`:
+
+```sh
+# Replace the values of 'localhost' and '9200' to the
+# corresponding host and port values for the cluster.
+openssl s_client -connect localhost:9200 -servername localhost -showcerts </dev/null 2>/dev/null \
+  | openssl x509 -fingerprint -sha256 -noout -in /dev/stdin
+```
+
+The output of `openssl x509` will look something like this:
+
+```sh
+SHA256 Fingerprint=A5:2D:D9:35:11:E8:C6:04:5E:21:F1:66:54:B7:7C:9E:E0:F3:4A:EA:26:D9:F4:03:20:B5:31:C4:74:67:62:28
+```
+
+## Connecting without security enabled [connect-no-security]
+
+::::{warning}
+Running {{es}} without security enabled is not recommended.
+::::
+
+If your cluster is configured with [security explicitly disabled](elasticsearch://reference/elasticsearch/configuration-reference/security-settings.md) then you can connect via HTTP:
+
+```js
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  node: 'http://example.com'
+})
+```
+
+## Authentication strategies [auth-strategies]
+
+Following you can find all the supported authentication strategies.
+
+### ApiKey authentication [auth-apikey]
+
+You can use the [ApiKey](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key) authentication by passing the `apiKey` parameter via the `auth` option. The `apiKey` parameter can be either a base64 encoded string or an object with the values that you can obtain from the [create api key endpoint](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key).
+
+::::{note}
+If you provide both basic authentication credentials and the ApiKey configuration, the ApiKey takes precedence.
+::::
+
+```js
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  node: 'https://localhost:9200',
+  auth: {
+    apiKey: 'base64EncodedKey'
+  }
+})
+```
+
+```js
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  node: 'https://localhost:9200',
+  auth: {
+    apiKey: {
+      id: 'foo',
+      api_key: 'bar'
+    }
+  }
+})
+```
+
+### Bearer authentication [auth-bearer]
+
+You can provide your credentials by passing the `bearer` token parameter via the `auth` option. Useful for [service account tokens](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-service-token). Be aware that it does not handle automatic token refresh.
+
+```js
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  node: 'https://localhost:9200',
+  auth: {
+    bearer: 'token'
+  }
+})
+```
+
+### Basic authentication [auth-basic]
+
+You can provide your credentials by passing the `username` and `password` parameters via the `auth` option.
+
+::::{note}
+If you provide both basic authentication credentials and the Api Key configuration, the Api Key will take precedence.
+::::
+
+```js
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  node: 'https://localhost:9200',
+  auth: {
+    username: 'elastic',
+    password: 'changeme'
+  }
+})
+```
+
+Otherwise, you can provide your credentials in the node(s) URL.
+
+```js
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  node: 'https://username:password@localhost:9200'
+})
+```
+
+## Usage [client-usage]
+
+Using the client is straightforward, it supports all the public APIs of {{es}}, and every method exposes the same signature.
+
+```js
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  cloud: { id: '<cloud-id>' },
+  auth: { apiKey: 'base64EncodedKey' }
+})
+
+const result = await client.search({
+  index: 'my-index',
+  query: {
+    match: { hello: 'world' }
+  }
+})
+```
+
+The returned value of every API call is the response body from {{es}}. If you need to access additonal metadata, such as the status code or headers, you must specify `meta: true` in the request options:
+
+```js
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  cloud: { id: '<cloud-id>' },
+  auth: { apiKey: 'base64EncodedKey' }
+})
+
+const result = await client.search({
+  index: 'my-index',
+  query: {
+    match: { hello: 'world' }
+  }
+}, { meta: true })
+```
+
+In this case, the result will be:
+
+```ts
+{
+  body: object | boolean
+  statusCode: number
+  headers: object
+  warnings: string[],
+  meta: object
+}
+```
+
+::::{note}
+The body is a boolean value when you use `HEAD` APIs.
+::::
+
+### Aborting a request [_aborting_a_request]
+
+If needed, you can abort a running request by using the `AbortController` standard.
+
+::::{warning}
+If you abort a request, the request will fail with a `RequestAbortedError`.
+::::
+
+```js
+const AbortController = require('node-abort-controller')
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  cloud: { id: '<cloud-id>' },
+  auth: { apiKey: 'base64EncodedKey' }
+})
+
+const abortController = new AbortController()
+setImmediate(() => abortController.abort())
+
+const result = await client.search({
+  index: 'my-index',
+  query: {
+    match: { hello: 'world' }
+  }
+}, { signal: abortController.signal })
+```
+
+### Request specific options [_request_specific_options]
+
+If needed you can pass request specific options in a second object:
+
+```js
+const result = await client.search({
+  index: 'my-index',
+  body: {
+    query: {
+      match: { hello: 'world' }
+    }
+  }
+}, {
+  ignore: [404],
+  maxRetries: 3
+})
+```
+
+The supported request specific options are:
+
+| Option | Description |
+| --- | ----------- |
+| `ignore` | `number[]` -  HTTP status codes which should not be considered errors for this request.<br>*Default:* `null` |
+| `requestTimeout` | `number` or `string` - Max request timeout for the request in milliseconds. This overrides the client default, which is to not time out at all. See [Elasticsearch best practices for HTML clients](elasticsearch://reference/elasticsearch/configuration-reference/networking-settings.md#_http_client_configuration) for more info.<br>_Default:_ No timeout |
+| `retryOnTimeout` | `boolean` - Retry requests that have timed out.*Default:* `false` |
+| `maxRetries` | `number` - Max number of retries for the request, it overrides the client default.<br>*Default:* `3` |
+| `compression` | `string` or  `boolean` - Enables body compression for the request.<br>*Options:* `false`, `'gzip'`<br>*Default:* `false` |
+| `asStream` | `boolean` - Instead of getting the parsed body back, you get the raw Node.js stream of data.<br>*Default:* `false` |
+| `headers` | `object` - Custom headers for the request.<br>*Default:* `null` |
+| `querystring` | `object` - Custom querystring for the request.<br>*Default:* `null` |
+| `id` | `any` - Custom request ID. *(overrides the top level request id generator)*<br>*Default:* `null` |
+| `context` | `any` - Custom object per request. *(you can use it to pass data to the clients events)*<br>*Default:* `null` |
+| `opaqueId` | `string` - Set the `X-Opaque-Id` HTTP header. See [X-Opaque-Id HTTP header](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md#x-opaque-id)<br>*Default:* `null` |
+| `maxResponseSize` | `number` - When configured, it verifies that the uncompressed response size is lower than the configured number, if it’s higher it will abort the request. It cannot be higher than buffer.constants.MAX_STRING_LENTGH<br>*Default:* `null` |
+| `maxCompressedResponseSize` | `number` - When configured, it verifies that the compressed response size is lower than the configured number, if it’s higher it will abort the request. It cannot be higher than buffer.constants.MAX_LENTGH<br>*Default:* `null` |
+| `signal` | `AbortSignal` - The AbortSignal instance to allow request abortion.<br>*Default:* `null` |
+| `meta` | `boolean` - Rather than returning the body, return an object containing `body`, `statusCode`, `headers` and `meta` keys<br>*Default*: `false` |
+| `redaction` | `object` - Options for redacting potentially sensitive data from error metadata. See [Redaction of potentially sensitive data](/reference/advanced-config.md#redaction). |
+| `retryBackoff` | `(min: number, max: number, attempt: number) => number;` - A function that calculates how long to sleep, in seconds, before the next request retry<br>_Default:_ A built-in function that uses exponential backoff with jitter. |
+
+## Using the Client in a Function-as-a-Service Environment [client-faas-env]
+
+This section illustrates the best practices for leveraging the {{es}} client in a Function-as-a-Service (FaaS) environment. The most influential optimization is to initialize the client outside of the function, the global scope. This practice does not only improve performance but also enables background functionality as – for example – [sniffing](https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how). The following examples provide a skeleton for the best practices.
+
+### GCP Cloud Functions [_gcp_cloud_functions]
+
+```js
+'use strict'
+
+const { Client } = require('@elastic/elasticsearch')
+
+const client = new Client({
+  // client initialisation
+})
+
+exports.testFunction = async function (req, res) {
+  // use the client
+}
+```
+
+### AWS Lambda [_aws_lambda]
+
+```js
+'use strict'
+
+const { Client } = require('@elastic/elasticsearch')
+
+const client = new Client({
+  // client initialisation
+})
+
+exports.handler = async function (event, context) {
+  // use the client
+}
+```
+
+### Azure Functions [_azure_functions]
+
+```js
+'use strict'
+
+const { Client } = require('@elastic/elasticsearch')
+
+const client = new Client({
+  // client initialisation
+})
+
+module.exports = async function (context, req) {
+  // use the client
+}
+```
+
+Resources used to assess these recommendations:
+
+* [GCP Cloud Functions: Tips & Tricks](https://cloud.google.com/functions/docs/bestpractices/tips#use_global_variables_to_reuse_objects_in_future_invocations)
+* [Best practices for working with AWS Lambda functions](https://docs.aws.amazon.com/lambda/latest/dg/best-practices.html)
+* [Azure Functions Python developer guide](https://docs.microsoft.com/en-us/azure/azure-functions/functions-reference-python?tabs=azurecli-linux%2Capplication-level#global-variables)
+* [AWS Lambda: Comparing the effect of global scope](https://docs.aws.amazon.com/lambda/latest/operatorguide/global-scope.html)
+
+## Connecting through a proxy [client-connect-proxy]
+
+Added in `v7.10.0`
+
+If you need to pass through an http(s) proxy for connecting to {{es}}, the client out of the box offers a handy configuration for helping you with it. Under the hood, it uses the [`hpagent`](https://github.com/delvedor/hpagent) module.
+
+::::{important}
+In versions 8.0+ of the client, the default `Connection` type is set to `UndiciConnection`, which does not support proxy configurations. To use a proxy, you will need to use the `HttpConnection` class from `@elastic/transport` instead.
+::::
+
+```js
+import { HttpConnection } from '@elastic/transport'
+
+const client = new Client({
+  node: 'http://localhost:9200',
+  proxy: 'http://localhost:8080',
+  Connection: HttpConnection,
+})
+```
+
+Basic authentication is supported as well:
+
+```js
+const client = new Client({
+  node: 'http://localhost:9200',
+  proxy: 'http:user:pwd@//localhost:8080',
+  Connection: HttpConnection,
+})
+```
+
+If you are connecting through a non-http(s) proxy, such as a `socks5` or `pac`, you can use the `agent` option to configure it.
+
+```js
+const SocksProxyAgent = require('socks-proxy-agent')
+const client = new Client({
+  node: 'http://localhost:9200',
+  agent () {
+    return new SocksProxyAgent('socks://127.0.0.1:1080')
+  },
+  Connection: HttpConnection,
+})
+```
+
+## Error handling [client-error-handling]
+
+The client exposes a variety of error objects that you can use to enhance your error handling. You can find all the error objects inside the `errors` key in the client.
+
+```js
+const { errors } = require('@elastic/elasticsearch')
+console.log(errors)
+```
+
+You can find the errors exported by the client in the table below.
+
+| **Error** | **Description** | **Properties** |
+| --- | --- | --- |
+| `ElasticsearchClientError` | Every error inherits from this class, it is the basic error generated by the client. | * `name` - `string`<br>* `message` - `string`<br> |
+| `TimeoutError` | Generated when a request exceeds the `requestTimeout` option. | * `name` - `string`<br>* `message` - `string`<br>* `meta` - `object`, contains all the information about the request<br> |
+| `ConnectionError` | Generated when an error occurs during the request, it can be a connection error or a malformed stream of data. | * `name` - `string`<br>* `message` - `string`<br>* `meta` - `object`, contains all the information about the request<br> |
+| `RequestAbortedError` | Generated if the user calls the `request.abort()` method. | * `name` - `string`<br>* `message` - `string`<br>* `meta` - `object`, contains all the information about the request<br> |
+| `NoLivingConnectionsError` | Given the configuration, the ConnectionPool was not able to find a usable Connection for this request. | * `name` - `string`<br>* `message` - `string`<br>* `meta` - `object`, contains all the information about the request<br> |
+| `SerializationError` | Generated if the serialization fails. | * `name` - `string`<br>* `message` - `string`<br>* `data` - `object`, the object to serialize<br> |
+| `DeserializationError` | Generated if the deserialization fails. | * `name` - `string`<br>* `message` - `string`<br>* `data` - `string`, the string to deserialize<br> |
+| `ConfigurationError` | Generated if there is a malformed configuration or parameter. | * `name` - `string`<br>* `message` - `string`<br> |
+| `ResponseError` | Generated when in case of a `4xx` or `5xx` response. | * `name` - `string`<br>* `message` - `string`<br>* `meta` - `object`, contains all the information about the request<br>* `body` - `object`, the response body<br>* `statusCode` - `object`, the response headers<br>* `headers` - `object`, the response status code<br> |
+
+
+## Keep-alive connections [keep-alive]
+
+By default, the client uses persistent, keep-alive connections to reduce the overhead of creating a new HTTP connection for each Elasticsearch request. If you are using the default `UndiciConnection` connection class, it maintains a pool of 256 connections with a keep-alive of 10 minutes. If you are using the legacy `HttpConnection` connection class, it maintains a pool of 256 connections with a keep-alive of 1 minute.
+
+If you need to disable keep-alive connections, you can override the HTTP agent with your preferred [HTTP agent options](https://nodejs.org/api/http.md#http_new_agent_options):
+
+```js
+const client = new Client({
+  node: 'http://localhost:9200',
+  // the function takes as parameter the option
+  // object passed to the Connection constructor
+  agent: (opts) => new CustomAgent()
+})
+```
+
+Or you can disable the HTTP agent entirely:
+
+```js
+const client = new Client({
+  node: 'http://localhost:9200',
+  // Disable agent and keep-alive
+  agent: false
+})
+```
+
+## Closing a client’s connections [close-connections]
+
+If you would like to close all open connections being managed by an instance of the client, use the `close()` function:
+
+```js
+const client = new Client({
+  node: 'http://localhost:9200'
+});
+client.close();
+```
+
+## Automatic product check [product-check]
+
+Since v7.14.0, the client performs a required product check before the first call. This pre-flight product check allows the client to establish the version of Elasticsearch that it is communicating with. The product check requires one additional HTTP request to be sent to the server as part of the request pipeline before the main API call is sent. In most cases, this will succeed during the very first API call that the client sends. Once the product check completes, no further product check HTTP requests are sent for subsequent API calls.

docs/reference/examples.md

@@ -0,0 +1,38 @@
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/examples.html
+---
+
+# Examples [examples]
+
+Following you can find some examples on how to use the client.
+
+* Use of the [asStream](/reference/as_stream_examples.md) parameter;
+* Executing a [bulk](/reference/bulk_examples.md) request;
+* Executing a [exists](/reference/exists_examples.md) request;
+* Executing a [get](/reference/get_examples.md) request;
+* Executing a [sql.query](/reference/sql_query_examples.md) request;
+* Executing a [update](/reference/update_examples.md) request;
+* Executing a [update by query](/reference/update_by_query_examples.md) request;
+* Executing a [reindex](/reference/reindex_examples.md) request;
+* Use of the [ignore](/reference/ignore_examples.md) parameter;
+* Executing a [msearch](/reference/msearch_examples.md) request;
+* How do I [scroll](/reference/scroll_examples.md)?
+* Executing a [search](/reference/search_examples.md) request;
+* I need [suggestions](/reference/suggest_examples.md);
+* How to use the [transport.request](/reference/transport_request_examples.md) method;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

docs/reference/exists_examples.md

@@ -1,12 +1,18 @@
-[[exists_examples]]
-=== Exists
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/exists_examples.html
+---
+
+# Exists [exists_examples]
 
 Check that the document `/game-of-thrones/1` exists.
 
-NOTE: Since this API uses the `HEAD` method, the body value will be boolean.
+::::{note}
+Since this API uses the `HEAD` method, the body value will be boolean.
+::::
 
-[source,js]
----------
+
+```js
 'use strict'
 
 const { Client } = require('@elastic/elasticsearch')
@@ -34,4 +40,5 @@ async function run () {
 }
 
 run().catch(console.log)
----------
+```
+

docs/reference/get_examples.md

@@ -1,12 +1,13 @@
-[[get_examples]]
-=== Get
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/get_examples.html
+---
 
-The get API allows to get a typed JSON document from the index based on its id. 
-The following example gets a JSON document from an index called 
-`game-of-thrones`, under a type called `_doc`, with id valued `'1'`.
+# Get [get_examples]
 
-[source,js]
----------
+The get API allows to get a typed JSON document from the index based on its id. The following example gets a JSON document from an index called `game-of-thrones`, under a type called `_doc`, with id valued `'1'`.
+
+```js
 'use strict'
 
 const { Client } = require('@elastic/elasticsearch')
@@ -34,4 +35,5 @@ async function run () {
 }
 
 run().catch(console.log)
----------
+```
+

docs/reference/getting-started.md

@@ -0,0 +1,150 @@
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html
+  - https://www.elastic.co/guide/en/serverless/current/elasticsearch-nodejs-client-getting-started.html
+---
+
+# Getting started [getting-started-js]
+
+This page guides you through the installation process of the Node.js client, shows you how to instantiate the client, and how to perform basic Elasticsearch operations with it.
+
+
+### Requirements [_requirements]
+
+* [Node.js](https://nodejs.org/) version 14.x or newer
+* [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm), usually bundled with Node.js
+
+
+### Installation [_installation]
+
+To install the latest version of the client, run the following command:
+
+```shell
+npm install @elastic/elasticsearch
+```
+
+Refer to the [*Installation*](/reference/installation.md) page to learn more.
+
+
+### Connecting [_connecting]
+
+You can connect to the Elastic Cloud using an API key and the Elasticsearch endpoint.
+
+```js
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  node: 'https://...', // Elasticsearch endpoint
+  auth: {
+    apiKey: { // API key ID and secret
+      id: 'foo',
+      api_key: 'bar',
+    }
+  }
+})
+```
+
+Your Elasticsearch endpoint can be found on the **My deployment** page of your deployment:
+
+![Finding Elasticsearch endpoint](images/es-endpoint.jpg)
+
+You can generate an API key on the **Management** page under Security.
+
+![Create API key](images/create-api-key.png)
+
+For other connection options, refer to the [*Connecting*](/reference/connecting.md) section.
+
+
+### Operations [_operations]
+
+Time to use Elasticsearch! This section walks you through the basic, and most important, operations of Elasticsearch.
+
+
+#### Creating an index [_creating_an_index]
+
+This is how you create the `my_index` index:
+
+```js
+await client.indices.create({ index: 'my_index' })
+```
+
+
+#### Indexing documents [_indexing_documents]
+
+This is a simple way of indexing a document:
+
+```js
+await client.index({
+  index: 'my_index',
+  id: 'my_document_id',
+  document: {
+    foo: 'foo',
+    bar: 'bar',
+  },
+})
+```
+
+
+#### Getting documents [_getting_documents]
+
+You can get documents by using the following code:
+
+```js
+await client.get({
+  index: 'my_index',
+  id: 'my_document_id',
+})
+```
+
+
+#### Searching documents [_searching_documents]
+
+This is how you can create a single match query with the client:
+
+```js
+await client.search({
+  query: {
+    match: {
+      foo: 'foo'
+    }
+  }
+})
+```
+
+
+#### Updating documents [_updating_documents]
+
+This is how you can update a document, for example to add a new field:
+
+```js
+await client.update({
+  index: 'my_index',
+  id: 'my_document_id',
+  doc: {
+    foo: 'bar',
+    new_field: 'new value'
+  }
+})
+```
+
+
+#### Deleting documents [_deleting_documents]
+
+```js
+await client.delete({
+  index: 'my_index',
+  id: 'my_document_id',
+})
+```
+
+
+#### Deleting an index [_deleting_an_index]
+
+```js
+await client.indices.delete({ index: 'my_index' })
+```
+
+
+## Further reading [_further_reading]
+
+* Use [*Client helpers*](/reference/client-helpers.md) for a more comfortable experience with the APIs.
+* For an elaborate example of how to ingest data into Elastic Cloud, refer to [this page](docs-content://manage-data/ingest/ingesting-data-from-applications/ingest-data-with-nodejs-on-elasticsearch-service.md).

docs/reference/ignore_examples.md

@@ -1,10 +1,13 @@
-[[ignore_examples]]
-=== Ignore
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/ignore_examples.html
+---
+
+# Ignore [ignore_examples]
 
 HTTP status codes which should not be considered errors for this request.
 
-[source,js]
-----
+```js
 'use strict'
 
 const { Client } = require('@elastic/elasticsearch')
@@ -62,4 +65,5 @@ async function run () {
 }
 
 run().catch(console.log)
-----
+```
+

docs/reference/index.md

@@ -1,12 +1,14 @@
-[[introduction]]
-== Introduction
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/index.html
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/introduction.html
+---
 
-This is the official Node.js client for {es}. This page gives a quick overview 
-about the features of the client.
+# JavaScript [introduction]
 
+This is the official Node.js client for {{es}}. This page gives a quick overview about the features of the client.
 
-[discrete]
-=== Features
+## Features [_features]
 
 * One-to-one mapping with REST API.
 * Generalized, pluggable architecture.
@@ -16,46 +18,35 @@ about the features of the client.
 * Child client support.
 * TypeScript support out of the box.
 
+### Install multiple versions [_install_multiple_versions]
 
-[discrete]
-==== Install multiple versions
-
-If you are using multiple versions of {es}, you need to use multiple versions of
-the client as well. In the past, installing multiple versions of the same
-package was not possible, but with `npm v6.9`, you can do it via aliasing.
+If you are using multiple versions of {{es}}, you need to use multiple versions of the client as well. In the past, installing multiple versions of the same package was not possible, but with `npm v6.9`, you can do it via aliasing.
 
 To install different version of the client, run the following command:
 
-[source,sh]
-----
+```sh
 npm install <alias>@npm:@elastic/elasticsearch@<version>
-----
-
+```
 
 For example, if you need to install `7.x` and `6.x`, run the following commands:
 
-[source,sh]
-----
+```sh
 npm install es6@npm:@elastic/elasticsearch@6
 npm install es7@npm:@elastic/elasticsearch@7
-----
-
+```
 
 Your `package.json` will look similar to the following example:
 
-[source,json]
-----
+```json
 "dependencies": {
   "es6": "npm:@elastic/elasticsearch@^6.7.0",
   "es7": "npm:@elastic/elasticsearch@^7.0.0"
 }
-----
-
+```
 
 Require the packages from your code by using the alias you have defined.
 
-[source,js]
-----
+```js
 const { Client: Client6 } = require('es6')
 const { Client: Client7 } = require('es7')
 
@@ -70,15 +61,14 @@ const client7 = new Client7({
 
 client6.info().then(console.log, console.log)
 client7.info().then(console.log, console.log)
-----
+```
 
+Finally, if you want to install the client for the next version of {{es}} (the one that lives in the {{es}} main branch), use the following command:
 
-Finally, if you want to install the client for the next version of {es} (the one
-that lives in the {es} main branch), use the following command:
-
-[source,sh]
-----
+```sh
 npm install esmain@github:elastic/elasticsearch-js
-----
-WARNING: This command installs the main branch of the client which is not
-considered stable.
+```
+
+::::{warning}
+This command installs the main branch of the client which is not considered stable.
+::::

docs/reference/installation.md

@@ -0,0 +1,61 @@
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/installation.html
+---
+
+# Installation [installation]
+
+This page guides you through the installation process of the client.
+
+To install the latest version of the client, run the following command:
+
+```sh
+npm install @elastic/elasticsearch
+```
+
+To install a specific major version of the client, run the following command:
+
+```sh
+npm install @elastic/elasticsearch@<major>
+```
+
+To learn more about the supported major versions, please refer to the [Compatibility matrix](#js-compatibility-matrix).
+
+## Node.js support [nodejs-support]
+
+::::{note}
+The minimum supported version of Node.js is `v18`.
+::::
+
+The client versioning follows the {{stack}} versioning, this means that major, minor, and patch releases are done following a precise schedule that often does not coincide with the [Node.js release](https://nodejs.org/en/about/releases/) times.
+
+To avoid support insecure and unsupported versions of Node.js, the client **will drop the support of EOL versions of Node.js between minor releases**. Typically, as soon as a Node.js version goes into EOL, the client will continue to support that version for at least another minor release. If you are using the client with a version of Node.js that will be unsupported soon, you will see a warning in your logs (the client will start logging the warning with two minors in advance).
+
+Unless you are **always** using a supported version of Node.js, we recommend defining the client dependency in your `package.json` with the `~` instead of `^`. In this way, you will lock the dependency on the minor release and not the major. (for example, `~7.10.0` instead of `^7.10.0`).
+
+| Node.js Version | Node.js EOL date | End of support      |
+| --------------- | ---------------- | ------------------- |
+| `8.x`           | December 2019    | `7.11` (early 2021) |
+| `10.x`          | April 2021       | `7.12` (mid 2021)   |
+| `12.x`          | April 2022       | `8.2` (early 2022)  |
+| `14.x`          | April 2023       | `8.8` (early 2023)  |
+| `16.x`          | September 2023   | `8.11` (late 2023)  |
+| `18.x`          | April 2025       | `9.2` (late 2025)   |
+
+## Compatibility matrix [js-compatibility-matrix]
+
+Language clients are forward compatible; meaning that clients support communicating with greater or equal minor versions of {{es}} without breaking. It does not mean that the client automatically supports new features of newer {{es}} versions; it is only possible after a release of a new client version. For example, a 8.12 client version won’t automatically support the new features of the 8.13 version of {{es}}, the 8.13 client version is required for that. {{es}} language clients are only backwards compatible with default distributions and without guarantees made.
+
+| {{es}} Version | Client Version | Supported |
+| -------------- | -------------- | --------- |
+| `9.x`          | `9.x`          | `9.x`     |
+| `8.x`          | `8.x`          | `8.x`     |
+| `7.x`          | `7.x`          | `7.17`    |
+| `6.x`          | `6.x`          |           |
+| `5.x`          | `5.x`          |           |
+
+### Browser [_browser]
+
+::::{warning}
+There is no official support for the browser environment. It exposes your {{es}} instance to everyone, which could lead to security issues. We recommend you to write a lightweight proxy that uses this client instead, you can see a proxy example [here](https://github.com/elastic/elasticsearch-js/tree/master/docs/examples/proxy).
+::::

docs/reference/integrations.md

@@ -0,0 +1,16 @@
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/integrations.html
+---
+
+# Integrations [integrations]
+
+The Client offers the following integration options for you:
+
+* [Observability](/reference/observability.md)
+* [Transport](/reference/transport.md)
+* [TypeScript support](/reference/typescript.md)
+
+
+
+

docs/reference/msearch_examples.md

@@ -1,11 +1,13 @@
-[[msearch_examples]]
-=== MSearch
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/msearch_examples.html
+---
 
-The multi search API allows to execute several search requests within the same 
-API. 
+# MSearch [msearch_examples]
 
-[source,js]
-----
+The multi search API allows to execute several search requests within the same API.
+
+```js
 'use strict'
 
 const { Client } = require('@elastic/elasticsearch')
@@ -57,4 +59,5 @@ async function run () {
 }
 
 run().catch(console.log)
-----
+```
+

docs/reference/observability.md

@@ -1,64 +1,52 @@
-[[observability]]
-=== Observability
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/observability.html
+---
+
+# Observability [observability]
 
 To observe and measure Elasticsearch client usage, several client features are provided.
 
 First, as of 8.15.0, the client provides native support for OpenTelemetry, which allows you to send client usage data to any endpoint that supports OpenTelemetry without having to make any changes to your JavaScript codebase.
 
-Also, rather than providing a default logger, the client offers an event
-emitter interface to hook into internal events, such as `request` and
-`response`, allowing you to log the events you care about, or otherwise react
-to client usage however you might need.
+Also, rather than providing a default logger, the client offers an event emitter interface to hook into internal events, such as `request` and `response`, allowing you to log the events you care about, or otherwise react to client usage however you might need.
 
-Correlating events can be hard, especially if your applications have a large codebase with many events happening at the same time. To help you with this, the client provides a correlation ID system, and other
-features.
+Correlating events can be hard, especially if your applications have a large codebase with many events happening at the same time. To help you with this, the client provides a correlation ID system, and other features.
 
 All of these observability features are documented below.
 
-[discrete]
-==== OpenTelemetry
+## OpenTelemetry [_opentelemetry]
 
-The client supports OpenTelemetry's https://opentelemetry.io/docs/zero-code/js/[zero-code
-instrumentation] to enable tracking each client request as an
-https://opentelemetry.io/docs/concepts/signals/traces/#spans[OpenTelemetry span]. These spans
-follow all of the https://opentelemetry.io/docs/specs/semconv/database/elasticsearch/[semantic
-OpenTelemetry conventions for Elasticsearch] except for `db.query.text`.
+The client supports OpenTelemetry’s [zero-code instrumentation](https://opentelemetry.io/docs/zero-code/js/) to enable tracking each client request as an [OpenTelemetry span](https://opentelemetry.io/docs/concepts/signals/traces/#spans). These spans follow all of the [semantic OpenTelemetry conventions for Elasticsearch](https://opentelemetry.io/docs/specs/semconv/database/elasticsearch/) except for `db.query.text`.
 
-To start sending Elasticsearch trace data to your OpenTelemetry endpoint, follow
-https://opentelemetry.io/docs/zero-code/js/[OpenTelemetry's zero-code instrumentation guide],
-or the following steps:
+To start sending Elasticsearch trace data to your OpenTelemetry endpoint, follow [OpenTelemetry’s zero-code instrumentation guide](https://opentelemetry.io/docs/zero-code/js/), or the following steps:
 
 1. Install `@opentelemetry/api` and `@opentelemetry/auto-instrumentations-node` as Node.js dependencies
 2. Export the following environment variables with the appropriate values:
-   - `OTEL_EXPORTER_OTLP_ENDPOINT`
-   - `OTEL_EXPORTER_OTLP_HEADERS`
-   - `OTEL_RESOURCE_ATTRIBUTES`
-   - `OTEL_SERVICE_NAME`
+
+    * `OTEL_EXPORTER_OTLP_ENDPOINT`
+    * `OTEL_EXPORTER_OTLP_HEADERS`
+    * `OTEL_RESOURCE_ATTRIBUTES`
+    * `OTEL_SERVICE_NAME`
+
 3. `require` the Node.js auto-instrumentation library at startup:
-[source,bash]
-----
+
+```
 node --require '@opentelemetry/auto-instrumentations-node/register' index.js
-----
+```
 
-[discrete]
-==== Events
+## Events [_events]
 
-The client is an event emitter. This means that you can listen for its events to
-add additional logic to your code, without needing to change the client's internals
-or how you use the client. You can find the events' names by accessing the `events` key
-of the client:
+The client is an event emitter. This means that you can listen for its events to add additional logic to your code, without needing to change the client’s internals or how you use the client. You can find the events' names by accessing the `events` key of the client:
 
-[source,js]
-----
+```js
 const { events } = require('@elastic/elasticsearch')
 console.log(events)
-----
+```
 
-The event emitter functionality can be useful if you want to log every request,
-response or error that is created by the client:
+The event emitter functionality can be useful if you want to log every request, response or error that is created by the client:
 
-[source,js]
-----
+```js
 const logger = require('my-logger')()
 const { Client } = require('@elastic/elasticsearch')
 const client = new Client({
@@ -73,72 +61,81 @@ client.diagnostic.on('response', (err, result) => {
     logger.info(result)
   }
 })
-----
+```
+
+### Event types
 
 The client emits the following events:
-[cols=2*]
-|===
-|`serialization`
-a|Emitted before starting serialization and compression. If you want to measure this phase duration, you should measure the time elapsed between this event and `request`.
-[source,js]
-----
-client.diagnostic.on('serialization', (err, result) => {
+
+#### `serialization`
+
+Emitted before starting serialization and compression. If you want to measure this phase duration, you should measure the time elapsed between this event and `request`.
+
+```js
+client.diagnostic.on("serialization", (err, result) => {
   console.log(err, result)
 })
-----
+```
 
-|`request`
-a|Emitted before sending the actual request to {es} _(emitted multiple times in case of retries)_.
-[source,js]
-----
-client.diagnostic.on('request', (err, result) => {
+#### `request`
+
+Emitted before sending the actual request to {{es}} _(emitted multiple times in case of retries)_.
+
+```js
+client.diagnostic.on("request", (err, result) => {
   console.log(err, result)
 })
-----
+```
 
-|`deserialization`
-a|Emitted before starting deserialization and decompression. If you want to measure this phase duration, you should measure the time elapsed between this event and `response`. This event might not be emitted in certain situations, like: when `asStream` is set to true; a response is terminated early due to content length being too large; or a response is terminated early by an `AbortController`.
-[source,js]
-----
-client.diagnostic.on('deserialization', (err, result) => {
+#### `deserialization`
+
+Emitted before starting deserialization and decompression. If you want to measure this phase duration, you should measure the time elapsed between this event and `response`.
+
+This event might not be emitted in certain situations:
+
+* When `asStream` is set to true, the response is returned in its raw stream form before deserialization occurs
+* When a response is terminated early due to content length being too large
+* When a response is terminated early by an `AbortController`
+
+```js
+client.diagnostic.on("deserialization", (err, result) => {
   console.log(err, result)
 })
-----
+```
 
-|`response`
-a|Emitted once {es} response has been received and parsed.
-[source,js]
-----
-client.diagnostic.on('response', (err, result) => {
+#### `response`
+
+Emitted once {{es}} response has been received and parsed.
+
+```js
+client.diagnostic.on("response", (err, result) => {
   console.log(err, result)
 })
-----
+```
 
-|`sniff`
-a|Emitted when the client ends a sniffing request.
-[source,js]
-----
-client.diagnostic.on('sniff', (err, result) => {
+#### `sniff`
+
+Emitted when the client ends a sniffing request.
+
+```js
+client.diagnostic.on("sniff", (err, result) => {
   console.log(err, result)
 })
-----
+```
 
-|`resurrect`
-a|Emitted if the client is able to resurrect a dead node.
-[source,js]
-----
-client.diagnostic.on('resurrect', (err, result) => {
+#### `resurrect`
+
+Emitted if the client is able to resurrect a dead node.
+
+```js
+client.diagnostic.on("resurrect", (err, result) => {
   console.log(err, result)
 })
-----
+```
 
-|===
+The values of `result` in `serialization`, `request`, `deserialization`, `response` and `sniff` are:
 
-The values of `result` in `serialization`, `request`, `deserialization`,
-`response` and `sniff` are:
-
-[source,ts]
-----
+```ts
 body: any;
 statusCode: number | null;
 headers: anyObject | null;
@@ -159,12 +156,11 @@ meta: {
     reason: string;
   };
 };
-----
+```
 
 While the `result` value in `resurrect` is:
 
-[source,ts]
-----
+```ts
 strategy: string;
 isAlive: boolean;
 connection: Connection;
@@ -172,19 +168,13 @@ name: string;
 request: {
   id: any;
 };
-----
+```
 
-[discrete]
-===== Events order
+### Events order [_events_order]
 
-The event order is described in the following graph, in some edge cases, the
-order is not guaranteed.
-You can find in
-https://github.com/elastic/elasticsearch-js/blob/main/test/acceptance/events-order.test.js[`test/acceptance/events-order.test.js`]
-how the order changes based on the situation.
+The event order is described in the following graph, in some edge cases, the order is not guaranteed. You can find in [`test/acceptance/events-order.test.js`](https://github.com/elastic/elasticsearch-js/blob/main/test/acceptance/events-order.test.js) how the order changes based on the situation.
 
-[source]
-----
+```
 serialization
   │
   │ (serialization and compression happens between those two events)
@@ -198,17 +188,13 @@ serialization
               │ (deserialization and decompression happens between those two events)
               │
               └─▶ response
-----
+```
 
-[discrete]
-==== Correlation ID
+## Correlation ID [_correlation_id]
 
-Correlating events can be hard, especially if there are many events at the same
-time. The client offers you an automatic (and configurable) system to help you
-handle this problem.
+Correlating events can be hard, especially if there are many events at the same time. The client offers you an automatic (and configurable) system to help you handle this problem.
 
-[source,js]
-----
+```js
 const { Client } = require('@elastic/elasticsearch')
 const client = new Client({
   cloud: { id: '<cloud-id>' },
@@ -233,13 +219,11 @@ client.search({
   index: 'my-index',
   query: { match_all: {} }
 }).then(console.log, console.log)
-----
+```
 
-By default the ID is an incremental integer, but you can configure it with the
-`generateRequestId` option:
+By default the ID is an incremental integer, but you can configure it with the `generateRequestId` option:
 
-[source,js]
-----
+```js
 const { Client } = require('@elastic/elasticsearch')
 const client = new Client({
   cloud: { id: '<cloud-id>' },
@@ -247,34 +231,28 @@ const client = new Client({
   // it takes two parameters, the request parameters and options
   generateRequestId: function (params, options) {
     // your id generation logic
-    // must be syncronous
+    // must be synchronous
     return 'id'
   }
 })
-----
-
+```
 
 You can also specify a custom ID per request:
 
-[source,js]
-----
+```js
 client.search({
   index: 'my-index',
   query: { match_all: {} }
 }, {
   id: 'custom-id'
 }).then(console.log, console.log)
-----
+```
 
+## Context object [_context_object]
 
-[discrete]
-==== Context object
+Sometimes, you might need to make some custom data available in your events, you can do that via the `context` option of a request:
 
-Sometimes, you might need to make some custom data available in your events, you
-can do that via the `context` option of a request:
-
-[source,js]
-----
+```js
 const { Client } = require('@elastic/elasticsearch')
 const client = new Client({
   cloud: { id: '<cloud-id>' },
@@ -303,14 +281,11 @@ client.search({
 }, {
   context: { winter: 'is coming' }
 }).then(console.log, console.log)
-----
+```
 
-The context object can also be configured as a global option in the client
-configuration. If you provide both, the two context objects will be shallow
-merged, and the API level object will take precedence.
+The context object can also be configured as a global option in the client configuration. If you provide both, the two context objects will be shallow merged, and the API level object will take precedence.
 
-[source,js]
-----
+```js
 const { Client } = require('@elastic/elasticsearch')
 const client = new Client({
   cloud: { id: '<cloud-id>' },
@@ -340,19 +315,13 @@ client.search({
 }, {
   context: { winter: 'has come' }
 }).then(console.log, console.log)
-----
+```
 
+## Client name [_client_name]
 
-[discrete]
-==== Client name
+If you are using multiple instances of the client or if you are using multiple child clients _(which is the recommended way to have multiple instances of the client)_, you might need to recognize which client you are using. The `name` options help you in this regard.
 
-If you are using multiple instances of the client or if you are using multiple
-child clients _(which is the recommended way to have multiple instances of the
-client)_, you might need to recognize which client you are using. The `name`
-options help you in this regard.
-
-[source,js]
-----
+```js
 const { Client } = require('@elastic/elasticsearch')
 const client = new Client({
   cloud: { id: '<cloud-id>' },
@@ -391,25 +360,15 @@ child.search({
   index: 'my-index',
   query: { match_all: {} }
 }).then(console.log, console.log)
-----
+```
 
+## X-Opaque-Id support [_x_opaque_id_support]
 
-[discrete]
-==== X-Opaque-Id support
+To improve observability, the client offers an easy way to configure the `X-Opaque-Id` header. If you set the `X-Opaque-Id` in a specific request, this allows you to discover this identifier in the [deprecation logs](docs-content://deploy-manage/monitor/logging-configuration/update-elasticsearch-logging-levels.md#deprecation-logging), helps you with [identifying search slow log origin](elasticsearch://reference/elasticsearch/index-settings/slow-log.md) as well as [identifying running tasks](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks).
 
-To improve observability, the client offers an easy way to configure the
-`X-Opaque-Id` header. If you set the `X-Opaque-Id` in a specific request, this
-allows you to discover this identifier in the
-https://www.elastic.co/guide/en/elasticsearch/reference/current/logging.html#deprecation-logging[deprecation logs],
-helps you with https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-slowlog.html#_identifying_search_slow_log_origin[identifying search slow log origin]
-as well as https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html#_identifying_running_tasks[identifying running tasks].
+The `X-Opaque-Id` should be configured in each request, for doing that you can use the `opaqueId` option, as you can see in the following example. The resulting header will be `{ 'X-Opaque-Id': 'my-search' }`.
 
-The `X-Opaque-Id` should be configured in each request, for doing that you can
-use the `opaqueId` option, as you can see in the following example. The
-resulting header will be `{ 'X-Opaque-Id': 'my-search' }`.
-
-[source,js]
-----
+```js
 const { Client } = require('@elastic/elasticsearch')
 const client = new Client({
   cloud: { id: '<cloud-id>' },
@@ -422,16 +381,11 @@ client.search({
 }, {
   opaqueId: 'my-search'
 }).then(console.log, console.log)
-----
+```
 
-Sometimes it may be useful to prefix all the `X-Opaque-Id` headers with a
-specific string, in case you need to identify a specific client or server. For
-doing this, the client offers a top-level configuration option:
-`opaqueIdPrefix`. In the following example, the resulting header will be
-`{ 'X-Opaque-Id': 'proxy-client::my-search' }`.
+Sometimes it may be useful to prefix all the `X-Opaque-Id` headers with a specific string, in case you need to identify a specific client or server. For doing this, the client offers a top-level configuration option: `opaqueIdPrefix`. In the following example, the resulting header will be `{ 'X-Opaque-Id': 'proxy-client::my-search' }`.
 
-[source,js]
-----
+```js
 const { Client } = require('@elastic/elasticsearch')
 const client = new Client({
   cloud: { id: '<cloud-id>' },
@@ -445,5 +399,4 @@ client.search({
 }, {
   opaqueId: 'my-search'
 }).then(console.log, console.log)
-----
-
+```

docs/reference/reindex_examples.md

@@ -1,17 +1,15 @@
-[[reindex_examples]]
-=== Reindex
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/reindex_examples.html
+---
 
-The `reindex` API extracts the document source from the source index and indexes 
-the documents into the destination index. You can copy all documents to the 
-destination index, reindex a subset of the documents or update the source before 
-to reindex it.
+# Reindex [reindex_examples]
 
-In the following example we have a `game-of-thrones` index which contains 
-different quotes of various characters, we want to create a new index only for 
-the house Stark and remove the `house` field from the document source.
+The `reindex` API extracts the document source from the source index and indexes the documents into the destination index. You can copy all documents to the destination index, reindex a subset of the documents or update the source before to reindex it.
 
-[source,js]
-----
+In the following example we have a `game-of-thrones` index which contains different quotes of various characters, we want to create a new index only for the house Stark and remove the `house` field from the document source.
+
+```js
 'use strict'
 
 const { Client } = require('@elastic/elasticsearch')
@@ -76,4 +74,5 @@ async function run () {
 }
 
 run().catch(console.log)
-----
+```
+

docs/reference/scroll_examples.md

@@ -1,28 +1,27 @@
-[[scroll_examples]]
-=== Scroll
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/scroll_examples.html
+---
 
-While a search request returns a single “page” of results, the scroll API can be 
-used to retrieve large numbers of results (or even all results) from a single 
-search request, in much the same way as you would use a cursor on a traditional 
-database.
+# Scroll [scroll_examples]
 
-Scrolling is not intended for real time user requests, but rather for processing 
-large amounts of data, for example in order to reindex the contents of one index 
-into a new index with a different configuration.
+While a search request returns a single “page” of results, the scroll API can be used to retrieve large numbers of results (or even all results) from a single search request, in much the same way as you would use a cursor on a traditional database.
 
-NOTE: The results that are returned from a scroll request reflect the state of 
-the index at the time that the initial search request was made, like a snapshot 
-in time. Subsequent changes to documents (index, update or delete) will only 
-affect later search requests.
+Scrolling is not intended for real time user requests, but rather for processing large amounts of data, for example in order to reindex the contents of one index into a new index with a different configuration.
 
-In order to use scrolling, the initial search request should specify the scroll 
-parameter in the query string, which tells {es} how long it should keep the 
-“search context” alive.
+::::{note}
+The results that are returned from a scroll request reflect the state of the index at the time that the initial search request was made, like a snapshot in time. Subsequent changes to documents (index, update or delete) will only affect later search requests.
+::::
 
-NOTE: Did you know that we provide an helper for sending scroll requests? You can find it {jsclient}/client-helpers.html[here].
 
-[source,js]
-----
+In order to use scrolling, the initial search request should specify the scroll parameter in the query string, which tells {{es}} how long it should keep the “search context” alive.
+
+::::{note}
+Did you know that we provide an helper for sending scroll requests? You can find it [here](/reference/client-helpers.md#scroll-search-helper).
+::::
+
+
+```js
 'use strict'
 
 const { Client } = require('@elastic/elasticsearch')
@@ -111,13 +110,11 @@ async function run () {
 }
 
 run().catch(console.log)
-----
+```
 
-Another cool usage of the `scroll` API can be done with Node.js ≥ 10, by using 
-async iteration!
+Another cool usage of the `scroll` API can be done with Node.js ≥ 10, by using async iteration!
 
-[source,js]
-----
+```js
 'use strict'
 
 const { Client } = require('@elastic/elasticsearch')
@@ -192,4 +189,5 @@ async function run () {
 }
 
 run().catch(console.log)
-----
+```
+

docs/reference/search_examples.md

@@ -1,14 +1,13 @@
-[[search_examples]]
-=== Search
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/search_examples.html
+---
 
-The `search` API allows you to execute a search query and get back search hits 
-that match the query. The query can either be provided using a simple 
-https://www.elastic.co/guide/en/elasticsearch/reference/6.6/search-uri-request.html[query string as a parameter], 
-or using a 
-https://www.elastic.co/guide/en/elasticsearch/reference/6.6/search-request-body.html[request body].
+# Search [search_examples]
 
-[source,js]
-----
+The `search` API allows you to execute a search query and get back search hits that match the query. The query can either be provided using a simple [query string as a parameter](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search), or using a [request body](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-body.html).
+
+```js
 'use strict'
 
 const { Client } = require('@elastic/elasticsearch')
@@ -61,4 +60,5 @@ async function run () {
 }
 
 run().catch(console.log)
-----
+```
+

docs/reference/sql_query_examples.md

@@ -1,19 +1,15 @@
-[[sql_query_examples]]
-=== SQL
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/sql_query_examples.html
+---
 
-{es} SQL is an X-Pack component that allows SQL-like queries to be executed in 
-real-time against {es}. Whether using the REST interface, command-line or JDBC, 
-any client can use SQL to search and aggregate data natively inside {es}. One 
-can think of {es} SQL as a translator, one that understands both SQL and {es} 
-and makes it easy to read and process data in real-time, at scale by leveraging 
-{es} capabilities.
+# SQL [sql_query_examples]
 
-In the following example we will search all the documents that has the field 
-`house` equals to `stark`, log the result with the tabular view and then 
-manipulate the result to obtain an object easy to navigate. 
+{{es}} SQL is an X-Pack component that allows SQL-like queries to be executed in real-time against {{es}}. Whether using the REST interface, command-line or JDBC, any client can use SQL to search and aggregate data natively inside {{es}}. One can think of {{es}} SQL as a translator, one that understands both SQL and {{es}} and makes it easy to read and process data in real-time, at scale by leveraging {{es}} capabilities.
 
-[source,js]
-----
+In the following example we will search all the documents that has the field `house` equals to `stark`, log the result with the tabular view and then manipulate the result to obtain an object easy to navigate.
+
+```js
 'use strict'
 
 const { Client } = require('@elastic/elasticsearch')
@@ -69,4 +65,5 @@ async function run () {
 }
 
 run().catch(console.log)
-----
+```
+

docs/reference/suggest_examples.md

@@ -1,14 +1,15 @@
-[[suggest_examples]]
-=== Suggest
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/suggest_examples.html
+---
 
-The suggest feature suggests similar looking terms based on a provided text by 
-using a suggester. _Parts of the suggest feature are still under development._
+# Suggest [suggest_examples]
 
-The suggest request part is defined alongside the query part in a `search` 
-request. If the query part is left out, only suggestions are returned.
+The suggest feature suggests similar looking terms based on a provided text by using a suggester. *Parts of the suggest feature are still under development.*
 
-[source,js]
-----
+The suggest request part is defined alongside the query part in a `search` request. If the query part is left out, only suggestions are returned.
+
+```js
 'use strict'
 
 const { Client } = require('@elastic/elasticsearch')
@@ -63,5 +64,5 @@ async function run () {
 }
 
 run().catch(console.log)
+```
 
-----

docs/reference/timeout-best-practices.md

@@ -0,0 +1,13 @@
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/timeout-best-practices.html
+---
+
+# Timeout best practices [timeout-best-practices]
+
+Starting in 9.0.0, this client is configured to not time out any HTTP request by default. {{es}} will always eventually respond to any request, even if it takes several minutes. Reissuing a request that it has not responded to yet can cause performance side effects. See the [official {{es}} recommendations for HTTP clients](elasticsearch://reference/elasticsearch/configuration-reference/networking-settings.md#_http_client_configuration) for more information.
+
+Prior to 9.0, this client was configured by default to operate like many HTTP client libraries do, by using a relatively short (30 second) timeout on all requests sent to {{es}}, raising a `TimeoutError` when that time period elapsed without receiving a response.
+
+If you need to set timeouts on Elasticsearch requests, setting the `requestTimeout` value to a millisecond value will cause this client to operate as it did prior to 9.0.
+

docs/reference/toc.yml

@@ -0,0 +1,35 @@
+toc:
+  - file: index.md
+  - file: getting-started.md
+  - file: installation.md
+  - file: connecting.md
+  - file: configuration.md
+    children:
+      - file: basic-config.md
+      - file: advanced-config.md
+      - file: child.md
+      - file: client-testing.md
+  - file: integrations.md
+    children:
+      - file: observability.md
+      - file: transport.md
+      - file: typescript.md
+  - file: api-reference.md
+  - file: examples.md
+    children:
+      - file: as_stream_examples.md
+      - file: bulk_examples.md
+      - file: exists_examples.md
+      - file: get_examples.md
+      - file: ignore_examples.md
+      - file: msearch_examples.md
+      - file: scroll_examples.md
+      - file: search_examples.md
+      - file: suggest_examples.md
+      - file: transport_request_examples.md
+      - file: sql_query_examples.md
+      - file: update_examples.md
+      - file: update_by_query_examples.md
+      - file: reindex_examples.md
+  - file: client-helpers.md
+  - file: timeout-best-practices.md

docs/reference/transport.md

@@ -0,0 +1,53 @@
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/transport.html
+---
+
+# Transport [transport]
+
+This class is responsible for performing the request to {{es}} and handling errors, it also handles sniffing.
+
+```js
+const { Client } = require('@elastic/elasticsearch')
+const { Transport } = require('@elastic/transport')
+
+class MyTransport extends Transport {
+  request (params, options, callback) {
+    // your code
+  }
+}
+
+const client = new Client({
+    Transport: MyTransport
+})
+```
+
+Sometimes you need to inject a small snippet of your code and then continue to use the usual client code. In such cases, call `super.method`:
+
+```js
+class MyTransport extends Transport {
+  request (params, options, callback) {
+    // your code
+    return super.request(params, options, callback)
+  }
+}
+```
+
+## Supported content types [_supported_content_types]
+
+Depending on the `content-type` of the response, the transport will return the body as different types:
+
+| Content-Type | JavaScript type |
+| --- | --- |
+| `application/json` | `object` |
+| `text/plain` | `string` |
+| `application/vnd.elasticsearch+json` | `object` |
+| `application/vnd.mapbox-vector-tile` | `Buffer` |
+| `application/vnd.apache.arrow.stream` | `Buffer` |
+| `application/vnd.elasticsearch+arrow+stream` | `Buffer` |
+| `application/smile` | `Buffer` |
+| `application/vnd.elasticsearch+smile` | `Buffer` |
+| `application/cbor` | `Buffer` |
+| `application/vnd.elasticsearch+cbor` | `Buffer` |
+
+

docs/reference/transport_request_examples.md

@@ -1,22 +1,23 @@
-[[transport_request_examples]]
-=== transport.request
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/transport_request_examples.html
+---
 
-It can happen that you need to communicate with {es} by using an API that is not 
-supported by the client, to mitigate this issue you can directly call 
-`client.transport.request`, which is the internal utility that the client uses 
-to communicate with {es} when you use an API method.
+# transport.request [transport_request_examples]
 
-NOTE: When using the `transport.request` method you must provide all the 
-parameters needed to perform an HTTP call, such as `method`, `path`, 
-`querystring`, and `body`.
+It can happen that you need to communicate with {{es}} by using an API that is not supported by the client, to mitigate this issue you can directly call `client.transport.request`, which is the internal utility that the client uses to communicate with {{es}} when you use an API method.
+
+::::{note}
+When using the `transport.request` method you must provide all the parameters needed to perform an HTTP call, such as `method`, `path`, `querystring`, and `body`.
+::::
 
 
-TIP: If you find yourself use this method too often, take in consideration the 
-use of `client.extend`, which will make your code look cleaner and easier to 
-maintain.
+::::{tip}
+If you find yourself use this method too often, take in consideration the use of `client.extend`, which will make your code look cleaner and easier to maintain.
+::::
 
-[source,js]
-----
+
+```js
 'use strict'
 
 const { Client } = require('@elastic/elasticsearch')
@@ -71,4 +72,5 @@ async function run () {
 }
 
 run().catch(console.log)
-----
+```
+

docs/reference/typescript.md

@@ -1,22 +1,21 @@
-[[typescript]]
-=== TypeScript support
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/typescript.html
+---
 
-The client offers a first-class support for TypeScript, shipping a complete set
-of type definitions of Elasticsearch's API surface.
+# TypeScript support [typescript]
 
-The types are not 100% complete yet. Some APIs are missing (the newest ones, e.g. EQL),
-and others may contain some errors, but we are continuously pushing fixes & improvements.
-Contribute type fixes and improvements to https://github.com/elastic/elasticsearch-specification[elasticsearch-specification github repository].
+The client offers a first-class support for TypeScript, shipping a complete set of type definitions of Elasticsearch’s API surface.
 
-NOTE: The client is developed against the https://www.npmjs.com/package/typescript?activeTab=versions[latest]
-version of TypeScript. Furthermore, unless you have set `skipLibCheck` to `true`,
-you should configure `esModuleInterop` to `true`.
+The types are not 100% complete yet. Some APIs are missing (the newest ones, e.g. EQL), and others may contain some errors, but we are continuously pushing fixes & improvements. Contribute type fixes and improvements to [elasticsearch-specification github repository](https://github.com/elastic/elasticsearch-specification).
 
-[discrete]
-==== Example
+::::{note}
+The client is developed against the [latest](https://www.npmjs.com/package/typescript?activeTab=versions) version of TypeScript. Furthermore, unless you have set `skipLibCheck` to `true`, you should configure `esModuleInterop` to `true`.
+::::
 
-[source,ts]
-----
+## Example [_example]
+
+```ts
 import { Client } from '@elastic/elasticsearch'
 
 const client = new Client({
@@ -71,21 +70,12 @@ async function run () {
 }
 
 run().catch(console.log)
-----
+```
 
-[discrete]
-==== Request & Response types
+## Request & Response types [_request_response_types]
 
 You can import the full TypeScript requests & responses definitions as it follows:
 
-[source,ts]
-----
+```ts
 import { estypes } from '@elastic/elasticsearch'
-----
-
-If you need the legacy definitions with the body, you can do the following:
-
-[source,ts]
-----
-import { estypesWithBody } from '@elastic/elasticsearch'
-----
+```

docs/reference/update_by_query_examples.md

@@ -1,12 +1,13 @@
-[[update_by_query_examples]]
-=== Update By Query
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/update_by_query_examples.html
+---
 
-The simplest usage of _update_by_query just performs an update on every document 
-in the index without changing the source. This is useful to pick up a new 
-property or some other online mapping change.
+# Update By Query [update_by_query_examples]
 
-[source,js]
----------
+The simplest usage of _update_by_query just performs an update on every document in the index without changing the source. This is useful to pick up a new property or some other online mapping change.
+
+```js
 'use strict'
 
 const { Client } = require('@elastic/elasticsearch')
@@ -56,5 +57,5 @@ async function run () {
 }
 
 run().catch(console.log)
+```
 
----------

docs/reference/update_examples.md

@@ -1,12 +1,13 @@
-[[update_examples]]
-=== Update
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/update_examples.html
+---
 
-The update API allows updates of a specific document using the given script. In 
-the following example, we will index a document that also tracks how many times 
-a character has said the given quote, and then we will update the `times` field.
+# Update [update_examples]
 
-[source,js]
----------
+The update API allows updates of a specific document using the given script. In the following example, we will index a document that also tracks how many times a character has said the given quote, and then we will update the `times` field.
+
+```js
 'use strict'
 
 const { Client } = require('@elastic/elasticsearch')
@@ -47,13 +48,11 @@ async function run () {
 }
 
 run().catch(console.log)
-
----------
+```
 
 With the update API, you can also run a partial update of a document.
 
-[source,js]
----------
+```js
 'use strict'
 
 const { Client } = require('@elastic/elasticsearch')
@@ -90,6 +89,5 @@ async function run () {
 }
 
 run().catch(console.log)
+```
 
-
----------

docs/release-notes/breaking-changes.md

@@ -0,0 +1,55 @@
+---
+navigation_title: "Breaking changes"
+---
+
+# Elasticsearch JavaScript Client breaking changes [elasticsearch-javascript-client-breaking-changes]
+
+Breaking changes can impact your Elastic applications, potentially disrupting normal operations. Before you upgrade, carefully review the Elasticsearch JavaScript Client breaking changes and take the necessary steps to mitigate any issues. To learn how to upgrade, check [Upgrade](docs-content://deploy-manage/upgrade.md).
+
+% ## Next version [elasticsearch-javascript-client-versionnext-breaking-changes]
+
+% ::::{dropdown} Title of breaking change
+% Description of the breaking change.
+% For more information, check [PR #](PR link).
+% **Impact**<br> Impact of the breaking change.
+% **Action**<br> Steps for mitigating deprecation impact.
+% ::::
+
+## 9.0.0 [elasticsearch-javascript-client-900-breaking-changes]
+
+::::{dropdown} Changes to the optional body property
+
+In 8.x, every API function had a `body` property that would provide a place to put arbitrary values that should go in the HTTP request body, even if they were not noted in the specification or documentation. In 9.0, each API function still includes an optional `body` property, but TypeScript's type checker will disallow properties that should go in the root of the object. A `querystring` parameter has also been added that behaves the same as `body`, but inserts its values into the request querystring.
+
+**Impact**<br> Some adjustments to API calls may be necessary for code that used a `body` property 8.x, especially to appease the TypeScript type checker, but it should not have any impact on any code that was not using a `body` property. The `estypesWithBody` export and `typesWithBodyKey` module are no longer available.
+
+**Action**<br> Check existing code for use of the `body` property, and move any properties that should be in the root object according to the API function's request type definition. If using TypeScript, the TypeScript type checker will surface most of these issues for you. Also look for any imports of `estypesWithBody` or `typesWithBodyKey` and update them to `estypes` and `types`, respectively.
+::::
+
+::::{dropdown} Changes to API parameter collation into an HTTP request
+
+The logic for where each parameter in an API function call should be added to its HTTP request has been updated:
+
+1. If recognized as a `body` parameter according to the Elasticsearch specification, put it in the JSON body
+2. If recognized as a `path` parameter, put it in the URL path
+3. If recognized as a `query` parameter or a "common" query parameter (e.g. `pretty`, `error_trace`), put it in the querystring
+4. If not recognized, and this API accepts a JSON body, put it in the JSON body
+5. If not recognized and this API does not accept a JSON body, put it in the querystring
+
+The first two steps are identical in 8.x. The final three steps replace the logic from 8.x that put all unrecognized parameters in the querystring.
+
+**Impact**<br> Some parameters that were sent via querystring to Elasticsearch may be sent in the JSON request body, and vice versa.
+
+**Action**<br> If Elasticsearch sends back an error response due to a request not being valid, verify with the client's TypeScript type definitions, or via the docs, that the parameters your code passes are correct.
+::::
+
+::::{dropdown} Removal of the default 30-second timeout on all API calls
+
+The default 30-second timeout on all HTTP requests sent to Elasticsearch has been dropped in favor of having no timeout set at all. The previous behavior still works as it did when setting the `requestTimeout` value.
+
+See pull request [#2573](https://github.com/elastic/elasticsearch-js/pull/2573) for more information.
+
+**Impact**<br> Requests to Elasticsearch that used to time out after 30 seconds will now wait for as long as it takes for Elasticsearch to respond.
+
+**Action**<br> In environments where it is not ideal to wait for an API response indefinitely, manually setting the `requestTimeout` option when instantiating the client still works as it did in 8.x.
+::::

docs/release-notes/deprecations.md

@@ -0,0 +1,21 @@
+---
+navigation_title: "Deprecations"
+---
+
+# Elasticsearch JavaScript Client deprecations [elasticsearch-javascript-client-deprecations]
+Over time, certain Elastic functionality becomes outdated and is replaced or removed. To help with the transition, Elastic deprecates functionality for a period before removal, giving you time to update your applications.
+
+Review the deprecated functionality for the Elasticsearch JavaScript Client. While deprecations have no immediate impact, we strongly encourage you update your implementation after you upgrade. To learn how to upgrade, check out [Upgrade](docs-content://deploy-manage/upgrade.md).
+
+## 9.0.0 [elasticsearch-javascript-client-900-deprecations]
+
+_No deprecations_
+
+% ## Next version
+
+% ::::{dropdown} Deprecation title
+% Description of the deprecation.
+% For more information, check [PR #](PR link).
+% **Impact**<br> Impact of deprecation. 
+% **Action**<br> Steps for mitigating deprecation impact.
+% ::::

docs/release-notes/index.md

@@ -0,0 +1,49 @@
+---
+navigation_title: "Elasticsearch JavaScript Client"
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/changelog-client.html
+---
+
+# Elasticsearch JavaScript Client release notes [elasticsearch-javascript-client-release-notes]
+
+Review the changes, fixes, and more in each version of Elasticsearch JavaScript Client.
+
+To check for security updates, go to [Security announcements for the Elastic stack](https://discuss.elastic.co/c/announcements/security-announcements/31).
+
+% Release notes include only features, enhancements, and fixes. Add breaking changes, deprecations, and known issues to the applicable release notes sections.
+
+% ## version.next [elasticsearch-javascript-client-next-release-notes]
+
+% ### Features and enhancements [elasticsearch-javascript-client-next-features-enhancements]
+% \*
+
+% ### Fixes [elasticsearch-javascript-client-next-fixes]
+% \*
+
+## 9.0.1
+
+### Fixes [elasticsearch-javascript-client-9.0.1-fixes]
+
+**Reinstate `nodeFilter` and node `roles` feature:** The docs note a `nodeFilter` option on the client that will, by default, filter the nodes based on any `roles` values that are set at instantiation. At some point, this functionality was partially disabled. This brings the feature back, ensuring that it matches what the documentation has said it does all along.
+
+**Ensure Apache Arrow ES|QL helper uses async iterator:** the [`esql.toArrowReader()` helper function](/reference/client-helpers.md#_toarrowreader) was trying to return `RecordBatchStreamReader`—a synchronous iterator—despite the fact that the `apache-arrow` package was, in most cases, automatically coercing it to `AsyncRecordBatchStreamReader`, its asynchronous counterpart. It now is always returned as an async iterator.
+
+## 9.0.0 [elasticsearch-javascript-client-9.0.0-release-notes]
+
+### Features and enhancements [elasticsearch-javascript-client-9.0.0-features-enhancements]
+
+- **Compatibility with Elasticsearch 9.0:** All changes and additions to Elasticsearch APIs for its 9.0 release are reflected in this release.
+- **Serverless client merged in:** the `@elastic/elasticsearch-serverless` client is being deprecated, and its functionality has been merged back into this client. This should have zero impact on the way the client works by default, except that a new `serverMode` option has been added. When it's explicitly set to `"serverless"` by a user, a few default settings and behaviors are changed:
+
+  - turns off sniffing and ignores any sniffing-related options
+  - ignores all nodes passed in config except the first one, and ignores any node filtering and selecting options
+  - enables compression and `TLSv1_2_method` (same as when configured for Elastic Cloud)
+  - adds an `elastic-api-version` HTTP header to all requests
+  - uses `CloudConnectionPool` by default instead of `WeightedConnectionPool`
+  - turns off vendored `content-type` and `accept` headers in favor or standard MIME types
+
+  Docstrings for types that differ between stack and serverless have also been updated to indicate when that is the case.
+
+- **Improved Cloud ID parsing:** when using a Cloud ID as the `cloud` parameter to instantiate the client, that ID was assumed to be in the correct format. New assertions have been added to verify that format and throw a `ConfigurationError` if it is invalid. See [#2694](https://github.com/elastic/elasticsearch-js/issues/2694).
+
+% ### Fixes [elasticsearch-javascript-client-9.0.0-fixes]

docs/release-notes/known-issues.md

@@ -0,0 +1,24 @@
+---
+navigation_title: "Known issues"
+
+---
+
+# Elasticsearch JavaScript Client known issues [elasticsearch-javascript-client-known-issues]
+
+## 9.0.0 
+
+_No known issues_
+
+% Use the following template to add entries to this page.
+
+% :::{dropdown} Title of known issue
+% **Details** 
+% On [Month/Day/Year], a known issue was discovered that [description of known issue].
+
+% **Workaround** 
+% Workaround description.
+
+% **Resolved**
+% On [Month/Day/Year], this issue was resolved.
+
+% :::

docs/release-notes/toc.yml

@@ -0,0 +1,5 @@
+toc:
+  - file: index.md
+  - file: known-issues.md
+  - file: breaking-changes.md
+  - file: deprecations.md

docs/testing.asciidoc

@@ -1,158 +0,0 @@
-[[client-testing]]
-=== Testing
-
-Testing is one of the most important parts of developing an application.
-The client is very flexible when it comes to testing and is compatible with
-most testing frameworks (such as https://www.npmjs.com/package/ava[`ava`],
-which is used in the examples below).
-
-If you are using this client, you are most likely working with {es}, and one of 
-the first issues you face is how to test your application. A perfectly valid 
-solution is to use the real {es} instance for testing your application, but you 
-would be doing an integration test, while you want a unit test. There are many 
-ways to solve this problem, you could create the database with Docker, or use an 
-in-memory compatible one, but if you are writing unit tests that can be easily 
-parallelized this becomes quite uncomfortable. A different way of improving your 
-testing experience while doing unit tests is to use a mock.
-
-The client is designed to be easy to extend and adapt to your needs. Thanks to 
-its internal architecture it allows you to change some specific components while 
-keeping the rest of it working as usual. Each {es} official client is composed 
-of the following components:
-
-* `API layer`: every {es} API that you can call.
-* `Transport`: a component that takes care of preparing a request before sending 
-  it and handling all the retry and sniffing strategies.
-* `ConnectionPool`: {es} is a cluster and might have multiple nodes, the 
-  `ConnectionPool` takes care of them.
-* `Serializer`: A class with all the serialization strategies, from the basic 
-  JSON to the new line delimited JSON.
-* `Connection`: The actual HTTP library.
-
-The best way to mock {es} with the official clients is to replace the 
-`Connection` component since it has very few responsibilities and it does not 
-interact with other internal components other than getting requests and 
-returning responses.
-
-
-[discrete]
-==== `@elastic/elasticsearch-mock`
-
-Writing each time a mock for your test can be annoying and error-prone, so we 
-have built a simple yet powerful mocking library specifically designed for this 
-client, and you can install it with the following command:
-
-[source,sh]
-----
-npm install @elastic/elasticsearch-mock --save-dev
-----
-
-With this library you can create custom mocks for any request you can send to 
-{es}. It offers a simple and intuitive API and it mocks only the HTTP layer, 
-leaving the rest of the client working as usual.
-
-Before showing all of its features, and what you can do with it, let’s see an 
-example:
-
-[source,js]
-----
-const { Client } = require('@elastic/elasticsearch')
-const Mock = require('@elastic/elasticsearch-mock')
-
-const mock = new Mock()
-const client = new Client({
-  cloud: { id: '<cloud-id>' },
-  auth: { apiKey: 'base64EncodedKey' },
-  Connection: mock.getConnection()
-})
-
-mock.add({
-  method: 'GET',
-  path: '/'
-}, () => {
-  return { status: 'ok' }
-})
-
-client.info().then(console.log, console.log)
-----
-
-As you can see it works closely with the client itself, once you have created a 
-new instance of the mock library you just need to call the mock.getConnection()
-method and pass its result to the Connection option of the client. From now on, 
-every request is handled by the mock library,  and the HTTP layer will never be 
-touched. As a result, your test is significantly faster and you are able to 
-easily parallelize them!
-
-The library allows you to write both “strict” and “loose” mocks, which means 
-that you can write a mock that handles a very specific request or be looser and 
-handle a group of request, let’s see this in action:
-
-[source,js]
-----
-mock.add({
-  method: 'POST',
-  path: '/indexName/_search'
-}, () => {
-  return {
-    hits: {
-      total: { value: 1, relation: 'eq' },
-      hits: [{ _source: { baz: 'faz' } }]
-    }
-  }
-})
-
-mock.add({
-  method: 'POST',
-  path: '/indexName/_search',
-  body: { query: { match: { foo: 'bar' } } }
-}, () => {
-  return {
-    hits: {
-      total: { value: 0, relation: 'eq' },
-      hits: []
-    }
-  }
-})
-----
-
-In the example above, every search request gets the first response, while every 
-search request that uses the query described in the second mock gets the second 
-response.
-
-You can also specify dynamic paths:
-
-[source,js]
-----
-mock.add({
-  method: 'GET',
-  path: '/:index/_count'
-}, () => {
-  return { count: 42 }
-})
-
-client.count({ index: 'foo' }).then(console.log, console.log) // => { count: 42 }
-client.count({ index: 'bar' }).then(console.log, console.log) // => { count: 42 }
-----
-
-And wildcards are supported as well.
-
-Another very interesting use case is the ability to create a test that randomly
-fails to see how your code reacts to failures:
-
-[source,js]
-----
-mock.add({
-  method: 'GET',
-  path: '/:index/_count'
-}, () => {
-  if (Math.random() > 0.8) {
-    return ResponseError({ body: {}, statusCode: 500 })
-  } else {
-    return { count: 42 }
-  }
-})
-----
-
-We have seen how simple is mocking {es} and testing your application, you can 
-find many more features and examples in the 
-https://github.com/elastic/elasticsearch-js-mock[module documentation].

docs/timeout-best-practices.asciidoc

@@ -1,10 +0,0 @@
-[[timeout-best-practices]]
-=== Timeout best practices
-
-This client is configured by default to operate like many HTTP client libraries do, by using a relatively short (30 second) timeout on all requests sent to {es}, raising a `TimeoutError` when that time period has elapsed without receiving a response. However, {es} will always eventually respond to any request, even if it takes several minutes. The {ref}/modules-network.html#_http_client_configuration[official {es} recommendation] is to disable response timeouts entirely by default.
-
-Since changing this default would be a breaking change, we won't do that until the next major release. In the meantime, here is our recommendation for properly configuring your client:
-
-* Ensure keep-alive is enabled; this is the default, so no settings need to be changed, unless you have set `agent` to `false` or provided an alternate `agent` that disables keep-alive
-* If using the default `UndiciConnection`, disable request timeouts by setting `timeout` to `0`
-* If using the legacy `HttpConnection`, set `timeout` to a very large number (e.g. `86400000`, or one day)

docs/transport.asciidoc

@@ -1,73 +0,0 @@
-[[transport]]
-=== Transport
-
-This class is responsible for performing the request to {es} and handling
-errors, it also handles sniffing.
-
-[source,js]
-----
-const { Client } = require('@elastic/elasticsearch')
-const { Transport } = require('@elastic/transport')
-
-class MyTransport extends Transport {
-  request (params, options, callback) {
-    // your code
-  }
-}
-
-const client = new Client({
-    Transport: MyTransport
-})
-----
-
-Sometimes you need to inject a small snippet of your code and then continue to
-use the usual client code. In such cases, call `super.method`:
-
-[source,js]
-----
-class MyTransport extends Transport {
-  request (params, options, callback) {
-    // your code
-    return super.request(params, options, callback)
-  }
-}
-----
-
-==== Supported content types
-
-Depending on the `content-type` of the response, the transport will return the body as different types:
-
-[cols="1,1"]
-|===
-|Content-Type |JavaScript type
-
-|`application/json`
-|`object`
-
-|`text/plain`
-|`string`
-
-|`application/vnd.elasticsearch+json`
-|`object`
-
-|`application/vnd.mapbox-vector-tile`
-|`Buffer`
-
-|`application/vnd.apache.arrow.stream`
-|`Buffer`
-
-|`application/vnd.elasticsearch+arrow+stream`
-|`Buffer`
-
-|`application/smile`
-|`Buffer`
-
-|`application/vnd.elasticsearch+smile`
-|`Buffer`
-
-|`application/cbor`
-|`Buffer`
-
-|`application/vnd.elasticsearch+cbor`
-|`Buffer`
-|===

index.d.ts

@@ -1,20 +1,6 @@
 /*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
  */
 
 import Client from './lib/client'
@@ -22,7 +8,6 @@ import SniffingTransport from './lib/sniffingTransport'
 
 export * from '@elastic/transport'
 export * as estypes from './lib/api/types'
-export * as estypesWithBody from './lib/api/typesWithBodyKey'
 export { Client, SniffingTransport }
 export type { ClientOptions, NodeOptions } from './lib/client'
 export * as helpers from './lib/helpers'

index.js

@@ -1,20 +1,6 @@
 /*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
  */
 
 'use strict'

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@elastic/elasticsearch",
-  "version": "8.18.2",
-  "versionCanary": "8.18.2-canary.0",
+  "version": "9.0.1",
+  "versionCanary": "9.0.1-canary.0",
   "description": "The official Elasticsearch client for Node.js",
   "main": "./index.js",
   "types": "index.d.ts",
@@ -23,6 +23,7 @@
     "lint": "ts-standard src",
     "lint:fix": "ts-standard --fix src",
     "license-checker": "license-checker --production --onlyAllow='MIT;Apache-2.0;Apache1.1;ISC;BSD-3-Clause;BSD-2-Clause;0BSD'",
+    "license-header": "./scripts/check-spdx",
     "prebuild": "npm run clean-build && npm run lint",
     "build": "tsc && rm lib/package.json && mv lib/src/* lib/ && rm -rf lib/src",
     "clean-build": "rimraf ./lib && mkdir lib",
@@ -57,11 +58,11 @@
     "node": ">=18"
   },
   "devDependencies": {
-    "@elastic/request-converter": "8.18.0",
+    "@elastic/request-converter": "9.0.1",
     "@sinonjs/fake-timers": "14.0.0",
     "@types/debug": "4.1.12",
     "@types/ms": "2.1.0",
-    "@types/node": "22.15.2",
+    "@types/node": "22.15.19",
     "@types/sinonjs__fake-timers": "8.1.5",
     "@types/split2": "4.2.3",
     "@types/stoppable": "1.1.3",
@@ -78,7 +79,7 @@
     "ora": "5.4.1",
     "proxy": "2.2.0",
     "rimraf": "6.0.1",
-    "semver": "7.7.1",
+    "semver": "7.7.2",
     "split2": "4.2.0",
     "stoppable": "1.1.0",
     "tap": "21.1.0",
@@ -87,11 +88,11 @@
     "typescript": "5.8.3",
     "workq": "3.0.0",
     "xmlbuilder2": "3.1.1",
-    "zx": "7.2.3"
+    "zx": "8.5.4"
   },
   "dependencies": {
-    "@elastic/transport": "^8.9.6",
-    "apache-arrow": "18.x - 19.x",
+    "@elastic/transport": "^9.0.1",
+    "apache-arrow": "18.x - 20.x",
     "tslib": "^2.4.0"
   },
   "tap": {

renovate.json

@@ -0,0 +1,34 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "local>elastic/renovate-config"
+  ],
+  "schedule": [
+    "* * * * 0"
+  ],
+  "packageRules": [
+    {
+      "matchDepTypes": [
+        "devDependencies"
+      ],
+      "automerge": true,
+      "labels": [
+        "backport 8.x"
+      ]
+    },
+    {
+      "matchManagers": [
+        "dockerfile"
+      ],
+      "pinDigests": false,
+      "automerge": true
+    },
+    {
+      "matchDatasources": [
+        "docker"
+      ],
+      "pinDigests": false,
+      "automerge": true
+    }
+  ]
+}

scripts/check-spdx

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+
+# Copyright Elasticsearch B.V. and contributors
+# SPDX-License-Identifier: Apache-2.0
+
+correct='/*
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */'
+
+the_exit=0
+
+check_file() {
+  if $(diff <(head -n4 "$1") <(echo "$correct") &>/dev/null); then
+    echo "Correct: $1"
+  else
+    echo "Incorrect: $1"
+    the_exit=1
+  fi
+}
+
+echo "SPDX license header check"
+for file in $(git ls-files | grep -E '\.(ts|js|mjs)$'); do
+  check_file "$file"
+done
+
+exit "$the_exit"

scripts/download-artifacts.js

@@ -1,20 +1,6 @@
 /*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
  */
 
 const { join } = require('path')

scripts/generate-docs-examples.js

@@ -1,20 +1,6 @@
 /*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
  */
 
 const { join } = require('path')

scripts/generate.js

@@ -1,143 +0,0 @@
-/*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-'use strict'
-
-const { join } = require('path')
-const { readdirSync, writeFileSync, readFileSync } = require('fs')
-const minimist = require('minimist')
-const ora = require('ora')
-const rimraf = require('rimraf')
-const standard = require('standard')
-const downloadArtifacts = require('./download-artifacts')
-const {
-  generate,
-  genFactory,
-  generateDocs,
-  generateRequestTypes
-} = require('./utils')
-
-start(minimist(process.argv.slice(2), {
-  string: ['version', 'hash']
-}))
-
-function start (opts) {
-  if (opts.version == null) {
-    console.error('Missing version parameter')
-    process.exit(1)
-  }
-
-  const packageFolder = join(__dirname, '..', 'api')
-  const apiOutputFolder = join(packageFolder, 'api')
-  const mainOutputFile = join(packageFolder, 'index.js')
-  const docOutputFile = join(__dirname, '..', 'docs', 'reference.asciidoc')
-  const typeDefFile = join(__dirname, '..', 'index.d.ts')
-  const requestParamsOutputFile = join(packageFolder, 'requestParams.d.ts')
-
-  let log
-  downloadArtifacts({ version: opts.version, hash: opts.hash })
-    .then(onArtifactsDownloaded)
-    .catch(err => {
-      console.log(err)
-      process.exit(1)
-    })
-
-  function onArtifactsDownloaded () {
-    log = ora('Generating APIs').start()
-
-    log.text = 'Cleaning API folder...'
-    rimraf.sync(join(apiOutputFolder, '*.js'))
-
-    const allSpec = readdirSync(downloadArtifacts.locations.specFolder)
-      .filter(file => file !== '_common.json')
-      .filter(file => !file.includes('deprecated'))
-      .sort()
-      .map(file => require(join(downloadArtifacts.locations.specFolder, file)))
-
-    const namespaces = namespacify(readdirSync(downloadArtifacts.locations.specFolder))
-    for (const namespace in namespaces) {
-      if (namespace === '_common') continue
-      const code = generate(namespace, namespaces[namespace], downloadArtifacts.locations.specFolder, opts.version)
-      const filePath = join(apiOutputFolder, `${namespace}.js`)
-      writeFileSync(filePath, code, { encoding: 'utf8' })
-    }
-
-    writeFileSync(
-      requestParamsOutputFile,
-      generateRequestTypes(opts.version, allSpec),
-      { encoding: 'utf8' }
-    )
-
-    const { fn: factory, types } = genFactory(apiOutputFolder, downloadArtifacts.locations.specFolder, namespaces)
-    writeFileSync(
-      mainOutputFile,
-      factory,
-      { encoding: 'utf8' }
-    )
-
-    const oldTypeDefString = readFileSync(typeDefFile, 'utf8')
-    const start = oldTypeDefString.indexOf('/* GENERATED */')
-    const end = oldTypeDefString.indexOf('/* /GENERATED */')
-    const newTypeDefString = oldTypeDefString.slice(0, start + 15) + '\n' + types + '\n  ' + oldTypeDefString.slice(end)
-    writeFileSync(
-      typeDefFile,
-      newTypeDefString,
-      { encoding: 'utf8' }
-    )
-
-    lintFiles(log, () => {
-      log.text = 'Generating documentation'
-      writeFileSync(
-        docOutputFile,
-        generateDocs(require(join(downloadArtifacts.locations.specFolder, '_common.json')), allSpec),
-        { encoding: 'utf8' }
-      )
-
-      log.succeed('Done!')
-    })
-  }
-
-  function lintFiles (log, cb) {
-    log.text = 'Linting...'
-    const files = [join(packageFolder, '*.js'), join(apiOutputFolder, '*.js')]
-    standard.lintFiles(files, { fix: true }, err => {
-      if (err) {
-        return log.fail(err.message)
-      }
-      cb()
-    })
-  }
-
-  function namespacify (apis) {
-    return apis
-      .map(api => api.slice(0, -5))
-      .filter(api => api !== '_common')
-      .filter(api => !api.includes('deprecated'))
-      .reduce((acc, val) => {
-        if (val.includes('.')) {
-          val = val.split('.')
-          acc[val[0]] = acc[val[0]] || []
-          acc[val[0]].push(val[1])
-        } else {
-          acc[val] = []
-        }
-        return acc
-      }, {})
-  }
-}

scripts/kibana-docker.sh

@@ -1,8 +0,0 @@
-#!/bin/bash
-
-exec docker run \
-  --rm \
-  -e ELASTICSEARCH_URL="http://elasticsearch:9200" \
-  -p 5601:5601 \
-  --network=elastic \
-  docker.elastic.co/kibana/kibana:7.0.0-beta1

scripts/release-canary.js

@@ -1,3 +1,8 @@
+/*
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 'use strict'
 
 /**
@@ -130,9 +135,9 @@ release(
       'dry-run',
 
       // help text
-      'help',
+      'help'
     ],
-    alias: { help: 'h' },
+    alias: { help: 'h' }
   })
 )
   .catch(err => {

scripts/utils/clone-es.js

@@ -1,139 +0,0 @@
-/*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-'use strict'
-
-const { accessSync, mkdirSync } = require('fs')
-const { join } = require('path')
-const Git = require('simple-git')
-
-const esRepo = 'https://github.com/elastic/elasticsearch.git'
-const esFolder = join(__dirname, '..', '..', 'elasticsearch')
-const apiFolder = join(esFolder, 'rest-api-spec', 'src', 'main', 'resources', 'rest-api-spec', 'api')
-const xPackFolder = join(esFolder, 'x-pack', 'plugin', 'src', 'test', 'resources', 'rest-api-spec', 'api')
-
-function cloneAndCheckout (opts, callback) {
-  const { log, tag, branch } = opts
-  withTag(tag, callback)
-
-  /**
-   * Sets the elasticsearch repository to the given tag.
-   * If the repository is not present in `esFolder` it will
-   * clone the repository and the checkout the tag.
-   * If the repository is already present but it cannot checkout to
-   * the given tag, it will perform a pull and then try again.
-   * @param {string} tag
-   * @param {function} callback
-   */
-  function withTag (tag, callback) {
-    let fresh = false
-    let retry = 0
-
-    if (!pathExist(esFolder)) {
-      if (!createFolder(esFolder)) {
-        log.fail('Failed folder creation')
-        return
-      }
-      fresh = true
-    }
-
-    const git = Git(esFolder)
-
-    if (fresh) {
-      clone(checkout)
-    } else if (opts.branch) {
-      checkout(true)
-    } else {
-      checkout()
-    }
-
-    function checkout (alsoPull = false) {
-      if (branch) {
-        log.text = `Checking out branch '${branch}'`
-      } else {
-        log.text = `Checking out tag '${tag}'`
-      }
-      git.checkout(branch || tag, err => {
-        if (err) {
-          if (retry++ > 0) {
-            callback(new Error(`Cannot checkout tag '${tag}'`), { apiFolder, xPackFolder })
-            return
-          }
-          return pull(checkout)
-        }
-        if (alsoPull) {
-          return pull(checkout)
-        }
-        callback(null, { apiFolder, xPackFolder })
-      })
-    }
-
-    function pull (cb) {
-      log.text = 'Pulling elasticsearch repository...'
-      git.pull(err => {
-        if (err) {
-          callback(err, { apiFolder, xPackFolder })
-          return
-        }
-        cb()
-      })
-    }
-
-    function clone (cb) {
-      log.text = 'Cloning elasticsearch repository...'
-      git.clone(esRepo, esFolder, err => {
-        if (err) {
-          callback(err, { apiFolder, xPackFolder })
-          return
-        }
-        cb()
-      })
-    }
-  }
-
-  /**
-   * Checks if the given path exists
-   * @param {string} path
-   * @returns {boolean} true if exists, false if not
-   */
-  function pathExist (path) {
-    try {
-      accessSync(path)
-      return true
-    } catch (err) {
-      return false
-    }
-  }
-
-  /**
-   * Creates the given folder
-   * @param {string} name
-   * @returns {boolean} true on success, false on failure
-   */
-  function createFolder (name) {
-    try {
-      mkdirSync(name)
-      return true
-    } catch (err) {
-      return false
-    }
-  }
-}
-
-module.exports = cloneAndCheckout

scripts/utils/generateApis.js

@@ -1,553 +0,0 @@
-/*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-/* eslint camelcase: 0 */
-
-'use strict'
-
-const { join } = require('path')
-const dedent = require('dedent')
-const allowedMethods = {
-  noBody: ['GET', 'HEAD', 'DELETE'],
-  body: ['POST', 'PUT', 'DELETE']
-}
-
-// if a parameter is depracted in a minor release
-// we should be able to support it until the next major
-const deprecatedParameters = require('./patch.json')
-
-// list of apis that does not need any kind of validation
-// because of how the url is built or the `type` handling in ES7
-const noPathValidation = [
-  'create',
-  'exists',
-  'explain',
-  'get',
-  'get_source',
-  'index',
-  'indices.get_alias',
-  'indices.exists_alias',
-  'indices.get_field_mapping',
-  'indices.get_mapping',
-  'indices.get_settings',
-  'indices.put_mapping',
-  'indices.stats',
-  'delete',
-  'nodes.info',
-  'nodes.stats',
-  'nodes.usage',
-  'tasks.cancel',
-  'termvectors',
-  'update'
-]
-
-function generateNamespace (namespace, nested, specFolder, version) {
-  const common = require(join(specFolder, '_common.json'))
-  let code = dedent`
-  /*
-   * Licensed to Elasticsearch B.V. under one or more contributor
-   * license agreements. See the NOTICE file distributed with
-   * this work for additional information regarding copyright
-   * ownership. Elasticsearch B.V. licenses this file to you under
-   * the Apache License, Version 2.0 (the "License"); you may
-   * not use this file except in compliance with the License.
-   * You may obtain a copy of the License at
-   *
-   *    http://www.apache.org/licenses/LICENSE-2.0
-   *
-   * Unless required by applicable law or agreed to in writing,
-   * software distributed under the License is distributed on an
-   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-   * KIND, either express or implied.  See the License for the
-   * specific language governing permissions and limitations
-   * under the License.
-   */
-
-  'use strict'
-
-  /* eslint camelcase: 0 */
-  /* eslint no-unused-vars: 0 */
-
-  const { handleError, snakeCaseKeys, normalizeArguments, kConfigurationError } = require('../utils')
-`
-  if (nested.length > 0) {
-    let getters = ''
-    for (const n of nested) {
-      if (n.includes('_')) {
-        const nameSnaked = n
-          .replace(/\.([a-z])/g, k => k[1].toUpperCase())
-          .replace(/_([a-z])/g, k => k[1].toUpperCase())
-        getters += `${n}: { get () { return this.${nameSnaked} } },\n`
-      }
-    }
-    const api = generateMultiApi(version, namespace, nested, common, specFolder)
-    if (getters.length > 0) {
-      getters = `Object.defineProperties(${api.namespace}Api.prototype, {\n${getters}})`
-    }
-
-    code += `
-  const acceptedQuerystring = ${JSON.stringify(api.acceptedQuerystring)}
-  const snakeCase = ${JSON.stringify(api.snakeCase)}
-
-  function ${api.namespace}Api (transport, ConfigurationError) {
-    this.transport = transport
-    this[kConfigurationError] = ConfigurationError
-  }
-
-  ${api.code}
-
-  ${getters}
-
-  module.exports = ${api.namespace}Api
-    `
-  } else {
-    const spec = require(join(specFolder, `${namespace}.json`))
-    const api = generateSingleApi(version, spec, common)
-    code += `
-  const acceptedQuerystring = ${JSON.stringify(api.acceptedQuerystring)}
-  const snakeCase = ${JSON.stringify(api.snakeCase)}
-
-  ${api.code}
-
-  module.exports = ${api.name}Api
-    `
-  }
-  return code
-}
-
-function generateMultiApi (version, namespace, nested, common, specFolder) {
-  const namespaceSnaked = namespace
-    .replace(/\.([a-z])/g, k => k[1].toUpperCase())
-    .replace(/_([a-z])/g, k => k[1].toUpperCase())
-  let code = ''
-  const snakeCase = {}
-  const acceptedQuerystring = []
-  for (const n of nested) {
-    const nameSnaked = n
-      .replace(/\.([a-z])/g, k => k[1].toUpperCase())
-      .replace(/_([a-z])/g, k => k[1].toUpperCase())
-    const spec = require(join(specFolder, `${namespace}.${n}.json`))
-    const api = generateSingleApi(version, spec, common)
-    code += `${Uppercase(namespaceSnaked)}Api.prototype.${nameSnaked} = ${api.code}\n\n`
-    Object.assign(snakeCase, api.snakeCase)
-    for (const q of api.acceptedQuerystring) {
-      if (!acceptedQuerystring.includes(q)) {
-        acceptedQuerystring.push(q)
-      }
-    }
-  }
-  return { code, snakeCase, acceptedQuerystring, namespace: Uppercase(namespaceSnaked) }
-}
-
-function generateSingleApi (version, spec, common) {
-  const release = version.charAt(0)
-  const api = Object.keys(spec)[0]
-  const name = api
-    .replace(/\.([a-z])/g, k => k[1].toUpperCase())
-    .replace(/_([a-z])/g, k => k[1].toUpperCase())
-
-  const { paths } = spec[api].url
-  const { params } = spec[api]
-  const acceptedQuerystring = []
-  const required = []
-
-  const methods = paths.reduce((acc, val) => {
-    for (const method of val.methods) {
-      if (!acc.includes(method)) acc.push(method)
-    }
-    return acc
-  }, [])
-  const parts = paths.reduce((acc, val) => {
-    if (!val.parts) return acc
-    for (const part of Object.keys(val.parts)) {
-      if (!acc.includes(part)) acc.push(part)
-    }
-    return acc
-  }, [])
-
-  // get the required parts from the url
-  // if the url has at least one static path,
-  // then there are not required parts of the url
-  let allParts = []
-  for (const path of paths) {
-    if (path.parts) {
-      allParts.push(Object.keys(path.parts))
-    } else {
-      allParts = []
-      break
-    }
-  }
-  if (allParts.length > 0) {
-    intersect(...allParts).forEach(r => required.push(r))
-  }
-
-  for (const key in params) {
-    if (params[key].required) {
-      required.push(key)
-    }
-
-    acceptedQuerystring.push(key)
-    if (deprecatedParameters[release] && deprecatedParameters[release][key]) {
-      acceptedQuerystring.push(deprecatedParameters[release][key])
-    }
-  }
-
-  for (const key in spec[api]) {
-    const k = spec[api][key]
-    if (k && k.required) {
-      required.push(key)
-    }
-  }
-  if (common && common.params) {
-    for (const key in common.params) {
-      acceptedQuerystring.push(key)
-    }
-  }
-
-  const code = `
-  function ${name}Api (params, options, callback) {
-    ;[params, options, callback] = normalizeArguments(params, options, callback)
-
-    ${genRequiredChecks()}
-
-    ${genUrlValidation(paths, api)}
-
-    let { ${genQueryDenylist(false)}, ...querystring } = params
-    querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring)
-
-    let path = ''
-    ${buildPath()}
-
-    // build request object
-    const request = {
-      method,
-      path,
-      ${genBody(api, methods, spec[api].body, spec)}
-      querystring
-    }
-
-    return this.transport.request(request, options, callback)
-  }
-  `.trim() // always call trim to avoid newlines
-
-  return {
-    name,
-    code,
-    acceptedQuerystring: acceptedQuerystring,
-    snakeCase: genSnakeCaseMap(),
-    documentation: generateDocumentation(spec[api], api)
-  }
-
-  function genRequiredChecks () {
-    const code = required
-      .map(_genRequiredCheck)
-      .concat(_noBody())
-      .filter(Boolean)
-
-    if (code.length) {
-      code.unshift('// check required parameters')
-    }
-
-    return code.join('\n        ')
-
-    function _genRequiredCheck (param) {
-      const camelCased = param[0] === '_'
-        ? '_' + param.slice(1).replace(/_([a-z])/g, k => k[1].toUpperCase())
-        : param.replace(/_([a-z])/g, k => k[1].toUpperCase())
-
-      if (param === camelCased) {
-        const check = `
-          if (params['${param}'] == null) {
-            const err = new this[kConfigurationError]('Missing required parameter: ${param}')
-            return handleError(err, callback)
-          }
-        `
-        return check.trim()
-      } else {
-        const check = `
-          if (params['${param}'] == null && params['${camelCased}'] == null) {
-            const err = new this[kConfigurationError]('Missing required parameter: ${param} or ${camelCased}')
-            return handleError(err, callback)
-          }
-        `
-        return check.trim()
-      }
-    }
-
-    function _noBody () {
-      const check = `
-        if (params.body != null) {
-          const err = new this[kConfigurationError]('This API does not require a body')
-          return handleError(err, callback)
-        }
-      `
-      return spec[api].body === null ? check.trim() : ''
-    }
-  }
-
-  function genSnakeCaseMap () {
-    const toCamelCase = str => {
-      return str[0] === '_'
-        ? '_' + str.slice(1).replace(/_([a-z])/g, k => k[1].toUpperCase())
-        : str.replace(/_([a-z])/g, k => k[1].toUpperCase())
-    }
-
-    return acceptedQuerystring.reduce((acc, val, index) => {
-      if (toCamelCase(val) !== val) {
-        acc[toCamelCase(val)] = val
-      }
-      return acc
-    }, {})
-  }
-
-  function genQueryDenylist (addQuotes = true) {
-    const toCamelCase = str => {
-      return str[0] === '_'
-        ? '_' + str.slice(1).replace(/_([a-z])/g, k => k[1].toUpperCase())
-        : str.replace(/_([a-z])/g, k => k[1].toUpperCase())
-    }
-
-    const denylist = ['method', 'body']
-    parts.forEach(p => {
-      const camelStr = toCamelCase(p)
-      if (camelStr !== p) denylist.push(`${camelStr}`)
-      denylist.push(`${p}`)
-    })
-    return addQuotes ? denylist.map(q => `'${q}'`) : denylist
-  }
-
-  function buildPath () {
-    const toCamelCase = str => {
-      return str[0] === '_'
-        ? '_' + str.slice(1).replace(/_([a-z])/g, k => k[1].toUpperCase())
-        : str.replace(/_([a-z])/g, k => k[1].toUpperCase())
-    }
-
-    const genAccessKey = str => {
-      const camelStr = toCamelCase(str)
-      return camelStr === str
-        ? str
-        : `${str} || ${camelStr}`
-    }
-
-    const genCheck = path => {
-      return path
-        .split('/')
-        .filter(Boolean)
-        .map(p => p.startsWith('{') ? `(${genAccessKey(p.slice(1, -1))}) != null` : false)
-        .filter(Boolean)
-        .join(' && ')
-    }
-
-    const genPath = path => {
-      path = path
-        .split('/')
-        .filter(Boolean)
-        .map(p => p.startsWith('{') ? `encodeURIComponent(${genAccessKey(p.slice(1, -1))})` : `'${p}'`)
-        .join(' + \'/\' + ')
-      return path.length > 0 ? ('\'/\' + ' + path) : '\'/\''
-    }
-
-    let hasStaticPath = false
-    let sortedPaths = paths
-      // some legacy API have mutliple statis paths
-      // this filter removes them
-      .filter(p => {
-        if (p.path.includes('{')) return true
-        if (hasStaticPath === false && p.deprecated == null) {
-          hasStaticPath = true
-          return true
-        }
-        return false
-      })
-      // sort by number of parameters (desc)
-      .sort((a, b) => Object.keys(b.parts || {}).length - Object.keys(a.parts || {}).length)
-
-    const allDeprecated = paths.filter(path => path.deprecated != null)
-    if (allDeprecated.length === paths.length) sortedPaths = [paths[0]]
-
-    let code = ''
-    for (let i = 0; i < sortedPaths.length; i++) {
-      const { path, methods } = sortedPaths[i]
-      if (sortedPaths.length === 1) {
-        code += `if (method == null) method = ${generatePickMethod(methods)}
-          path = ${genPath(path)}
-        `
-      } else if (i === 0) {
-        code += `if (${genCheck(path)}) {
-            if (method == null) method = ${generatePickMethod(methods)}
-            path = ${genPath(path)}
-          }
-        `
-      } else if (i === sortedPaths.length - 1) {
-        code += ` else {
-            if (method == null) method = ${generatePickMethod(methods)}
-            path = ${genPath(path)}
-          }
-        `
-      } else {
-        code += ` else if (${genCheck(path)}) {
-            if (method == null) method = ${generatePickMethod(methods)}
-            path = ${genPath(path)}
-          }
-        `
-      }
-    }
-
-    return code
-  }
-}
-
-function generatePickMethod (methods) {
-  if (methods.length === 1) {
-    return `'${methods[0]}'`
-  }
-  const bodyMethod = getBodyMethod(methods)
-  const noBodyMethod = getNoBodyMethod(methods)
-  if (bodyMethod && noBodyMethod) {
-    return `body == null ? '${noBodyMethod}' : '${bodyMethod}'`
-  } else if (bodyMethod) {
-    return `'${bodyMethod}'`
-  } else {
-    return `'${noBodyMethod}'`
-  }
-}
-
-function genBody (api, methods, body, spec) {
-  const bodyMethod = getBodyMethod(methods)
-  const { content_type } = spec[api].headers
-  if (content_type && content_type.includes('application/x-ndjson')) {
-    return 'bulkBody: body,'
-  }
-  if (body === null && bodyMethod) {
-    return 'body: \'\','
-  } else if (bodyMethod) {
-    return 'body: body || \'\','
-  } else {
-    return 'body: null,'
-  }
-}
-
-function getBodyMethod (methods) {
-  const m = methods.filter(m => ~allowedMethods.body.indexOf(m))
-  if (m.length) return m[0]
-  return null
-}
-
-function getNoBodyMethod (methods) {
-  const m = methods.filter(m => ~allowedMethods.noBody.indexOf(m))
-  if (m.length) return m[0]
-  return null
-}
-
-function genUrlValidation (paths, api) {
-  // this api does not need url validation
-  if (!needsPathValidation(api)) return ''
-  // gets only the dynamic components of the url in an array
-  // then we reverse it. A parameters always require what is
-  // at its right in the array.
-  const chunks = paths
-    .sort((a, b) => Object.keys(a.parts || {}).length > Object.keys(b.parts || {}).length ? -1 : 1)
-    .slice(0, 1)
-    .reduce((acc, val) => val.path, '')
-    // .reduce((a, b) => a.path.split('/').length > b.path.split('/').length ? a.path : b.path)
-    .split('/')
-    .filter(s => s.startsWith('{'))
-    .map(s => s.slice(1, -1))
-    .reverse()
-
-  let code = ''
-
-  const len = chunks.length
-  chunks.forEach((chunk, index) => {
-    if (index === len - 1) return
-    const params = []
-    let camelCased = chunk[0] === '_'
-      ? '_' + chunk.slice(1).replace(/_([a-z])/g, k => k[1].toUpperCase())
-      : chunk.replace(/_([a-z])/g, k => k[1].toUpperCase())
-
-    if (chunk === camelCased) {
-      code += `${index ? '} else ' : ''}if (params['${chunk}'] != null && (`
-    } else {
-      code += `${index ? '} else ' : ''}if ((params['${chunk}'] != null || params['${camelCased}'] != null) && (`
-    }
-    for (let i = index + 1; i < len; i++) {
-      params.push(chunks[i])
-      // url parts can be declared in camelCase fashion
-      camelCased = chunks[i][0] === '_'
-        ? '_' + chunks[i].slice(1).replace(/_([a-z])/g, k => k[1].toUpperCase())
-        : chunks[i].replace(/_([a-z])/g, k => k[1].toUpperCase())
-
-      if (chunks[i] === camelCased) {
-        code += `params['${chunks[i]}'] == null${i === len - 1 ? '' : ' || '}`
-      } else {
-        code += `(params['${chunks[i]}'] == null && params['${camelCased}'] == null)${i === len - 1 ? '' : ' || '}`
-      }
-    }
-    code += `)) {
-      const err = new this[kConfigurationError]('Missing required parameter of the url: ${params.join(', ')}')
-      return handleError(err, callback)
-    `
-  })
-
-  if (chunks.length > 1) {
-    code += '\n}'
-  }
-
-  if (code.length) {
-    code = '// check required url components\n' + code
-  }
-
-  return code.trim()
-}
-
-function generateDocumentation ({ documentation }, op) {
-  // we use `replace(/\u00A0/g, ' ')` to remove no breaking spaces
-  // because some parts of the description fields are using it
-
-  if (documentation == null) return ''
-
-  let doc = '/**\n'
-  doc += `     * Perform a ${op} request\n`
-  if (documentation.description) {
-    doc += `     * ${documentation.description.replace(/\u00A0/g, ' ')}\n`
-  }
-  if (documentation.url) {
-    doc += `     * ${documentation.url}\n`
-  }
-  doc += '     */'
-
-  return doc
-}
-
-function needsPathValidation (api) {
-  return noPathValidation.indexOf(api) === -1
-}
-
-function intersect (first, ...rest) {
-  return rest.reduce((accum, current) => {
-    return accum.filter(x => current.indexOf(x) !== -1)
-  }, first)
-}
-
-function Uppercase (str) {
-  return str[0].toUpperCase() + str.slice(1)
-}
-
-module.exports = generateNamespace

scripts/utils/generateDocs.js

@@ -1,318 +0,0 @@
-/*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-'use strict'
-
-const { readdirSync } = require('fs')
-const { join } = require('path')
-const dedent = require('dedent')
-
-const codeExamples = readdirSync(join(__dirname, '..', '..', 'docs', 'examples'))
-  .map(file => file.slice(0, -9))
-  .filter(api => api !== 'index')
-
-function generateDocs (common, spec) {
-  let doc = dedent`
-  [[api-reference]]
-
-  ////////
-
-
-
-  ===========================================================================================================================
-  ||                                                                                                                       ||
-  ||                                                                                                                       ||
-  ||                                                                                                                       ||
-  ||        ██████╗ ███████╗ █████╗ ██████╗ ███╗   ███╗███████╗                                                            ||
-  ||        ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝                                                            ||
-  ||        ██████╔╝█████╗  ███████║██║  ██║██╔████╔██║█████╗                                                              ||
-  ||        ██╔══██╗██╔══╝  ██╔══██║██║  ██║██║╚██╔╝██║██╔══╝                                                              ||
-  ||        ██║  ██║███████╗██║  ██║██████╔╝██║ ╚═╝ ██║███████╗                                                            ||
-  ||        ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚══════╝                                                            ||
-  ||                                                                                                                       ||
-  ||                                                                                                                       ||
-  ||    This file is autogenerated, DO NOT send pull requests that changes this file directly.                             ||
-  ||    You should update the script that does the generation, which can be found in '/scripts/utils/generateDocs.js'.     ||
-  ||                                                                                                                       ||
-  ||    You can run the script with the following command:                                                                 ||
-  ||       node scripts/generate --branch <branch_name>                                                                    ||
-  ||    or                                                                                                                 ||
-  ||       node scripts/generate --tag <tag_name>                                                                          ||
-  ||                                                                                                                       ||
-  ||                                                                                                                       ||
-  ||                                                                                                                       ||
-  ===========================================================================================================================
-
-
-
-  ////////
-
-  == API Reference
-
-  This document contains the entire list of the Elasticsearch API supported by the client, both OSS and commercial. The client is entirely licensed under Apache 2.0.
-
-  Elasticsearch exposes an HTTP layer to communicate with, and the client is a library that will help you do this. Because of this reason, you will see HTTP related parameters, such as ${'`'}body${'`'} or ${'`'}headers${'`'}.
-
-  Every API can accept two objects, the first contains all the parameters that will be sent to Elasticsearch, while the second includes the request specific parameters, such as timeouts, headers, and so on.
-  In the first object, every parameter but the body will be sent via querystring or url parameter, depending on the API, and every unrecognized parameter will be sent as querystring.
-
-  [source,js]
-  ----
-  // promise API
-  const result = await client.search({
-    index: 'my-index',
-    from: 20,
-    size: 10,
-    body: { foo: 'bar' }
-  }, {
-    ignore: [404],
-    maxRetries: 3
-  })
-
-  // callback API
-  client.search({
-    index: 'my-index',
-    from: 20,
-    size: 10,
-    body: { foo: 'bar' }
-  }, {
-    ignore: [404],
-    maxRetries: 3
-  }, (err, result) => {
-    if (err) console.log(err)
-  })
-  ----
-
-  In this document, you will find the reference of every parameter accepted by the querystring or the url. If you also need to send the body, you can find the documentation of its format in the reference link that is present along with every endpoint.
-
-  \n\n`
-  doc += commonParameters(common)
-  spec.forEach(s => {
-    doc += '\n' + generateApiDoc(s)
-  })
-  return doc
-}
-
-function commonParameters (spec) {
-  let doc = dedent`
-  [discrete]
-  === Common parameters
-  Parameters that are accepted by all API endpoints.
-
-  link:{ref}/common-options.html[Documentation]
-  [cols=2*]
-  |===\n`
-  Object.keys(spec.params).forEach(key => {
-    const name = isSnakeCased(key) && key !== camelify(key)
-      ? '`' + key + '` or `' + camelify(key) + '`'
-      : '`' + key + '`'
-
-    doc += dedent`
-    |${name}
-    |${'`' + spec.params[key].type + '`'} - ${spec.params[key].description}`
-    if (spec.params[key].default) {
-      doc += ` +
-    _Default:_ ${'`' + spec.params[key].default + '`'}`
-    }
-    doc += '\n\n'
-  })
-
-  doc += dedent`
-  |===
-  `
-  return doc
-}
-
-function generateApiDoc (spec) {
-  const name = Object.keys(spec)[0]
-  const documentationUrl = spec[name].documentation && spec[name].documentation.url
-    ? fixLink(name, spec[name].documentation.url)
-    : ''
-  const params = []
-  // url params
-  const urlParts = spec[name].url.paths.reduce((acc, path) => {
-    if (!path.parts) return acc
-    for (const part in path.parts) {
-      if (acc[part] != null) continue
-      acc[part] = path.parts[part]
-    }
-    return acc
-  }, {})
-  if (urlParts) {
-    Object.keys(urlParts).forEach(param => {
-      params.push({
-        name: param,
-        type: getType(urlParts[param].type, urlParts[param].options),
-        description: urlParts[param].description,
-        default: urlParts[param].default,
-        deprecated: !!urlParts[param].deprecated
-      })
-    })
-  }
-
-  // query params
-  const urlParams = spec[name].params
-  if (urlParams) {
-    Object.keys(urlParams).forEach(param => {
-      const duplicate = params.find(ele => ele.name === param)
-      if (duplicate) return
-      params.push({
-        name: param,
-        type: getType(urlParams[param].type, urlParams[param].options),
-        description: urlParams[param].description,
-        default: urlParams[param].default,
-        deprecated: !!urlParams[param].deprecated
-      })
-    })
-  }
-
-  // body params
-  const body = spec[name].body
-  if (body) {
-    params.push({
-      name: 'body',
-      type: 'object',
-      description: body.description,
-      default: body.default,
-      deprecated: !!body.deprecated
-    })
-  }
-
-  const codeParameters = params
-    .reduce((acc, val) => {
-      const code = `${val.name}: ${val.type},`
-      acc += acc === ''
-        ? code
-        : '\n    ' + code
-
-      return acc
-    }, '')
-    // remove last comma
-    .slice(0, -1)
-
-  const stability = spec[name].stability === 'stable'
-    ? ''
-    : `*Stability:* ${spec[name].stability}`
-
-  let doc = dedent`
-  [discrete]
-  === ${camelify(name)}
-  ${stability}
-  [source,ts]
-  ----
-  client.${camelify(name)}(${codeParameters.length > 0 ? `{\n    ${codeParameters}\n}` : ''})
-  ----\n`
-  if (documentationUrl) {
-    doc += `link:${documentationUrl}[Documentation] +\n`
-  }
-  if (codeExamples.includes(name)) {
-    doc += `{jsclient}/${name.replace(/\./g, '_')}_examples.html[Code Example] +\n`
-  }
-
-  if (params.length !== 0) {
-    doc += dedent`[cols=2*]
-    |===\n`
-    doc += params.reduce((acc, val) => {
-      const name = isSnakeCased(val.name) && val.name !== camelify(val.name)
-        ? '`' + val.name + '` or `' + camelify(val.name) + '`'
-        : '`' + val.name + '`'
-      acc += dedent`
-      |${name}
-      |${'`' + val.type.replace(/\|/g, '\\|') + '`'} - ${val.description}`
-      if (val.default) {
-        acc += ` +\n_Default:_ ${'`' + val.default + '`'}`
-      }
-      if (val.deprecated) {
-        acc += ' +\n\nWARNING: This parameter has been deprecated.'
-      }
-      return acc + '\n\n'
-    }, '')
-
-    doc += dedent`
-    |===
-    `
-  }
-  doc += '\n'
-  return doc
-}
-
-const LINK_OVERRIDES = {
-  'license.delete': '{ref}/delete-license.html',
-  'license.get': '{ref}/get-license.html',
-  'license.get_basic_status': '{ref}/get-basic-status.html',
-  'license.get_trial_status': '{ref}/get-trial-status.html',
-  'license.post': '{ref}/update-license.html',
-  'license.post_start_basic': '{ref}/start-basic.html',
-  'license.post_start_trial': '{ref}/start-trial.html',
-  'migration.deprecations': '{ref}/migration-api-deprecation.html',
-  'monitoring.bulk': '{ref}/monitor-elasticsearch-cluster.html',
-  'ingest.delete_pipeline': '{ref}/delete-pipeline-api.html',
-  'ingest.get_pipeline': '{ref}/get-pipeline-api.html',
-  'ingest.put_pipeline': '{ref}/put-pipeline-api.html',
-  'ingest.simulate': '{ref}/simulate-pipeline-api.html',
-  'ingest.processor_grok': '{ref}/grok-processor.html#grok-processor-rest-get'
-}
-// Fixes bad urls in the JSON spec
-function fixLink (name, str) {
-  /* In 6.x some API start with `xpack.` when in master they do not. We
-   * can safely ignore that for link generation. */
-  name = name.replace(/^xpack\./, '')
-  const override = LINK_OVERRIDES[name]
-  if (override) return override
-  if (!str) return ''
-  /* Replace references to the guide with the attribute {ref} because
-   * the json files in the Elasticsearch repo are a bit of a mess. */
-  str = str.replace(/^.+guide\/en\/elasticsearch\/reference\/[^/]+\/([^./]*\.html(?:#.+)?)$/, '{ref}/$1')
-  str = str.replace(/frozen\.html/, 'freeze-index-api.html')
-  str = str.replace(/ml-file-structure\.html/, 'ml-find-file-structure.html')
-  str = str.replace(/security-api-get-user-privileges\.html/, 'security-api-get-privileges.html')
-
-  return str
-}
-
-function getType (type, options) {
-  switch (type) {
-    case 'list':
-      return 'string | string[]'
-    case 'date':
-    case 'time':
-    case 'timeout':
-      return 'string'
-    case 'enum':
-      return options.map(k => `'${k}'`).join(' | ')
-    case 'int':
-    case 'double':
-    case 'long':
-      return 'number'
-    default:
-      return type
-  }
-}
-
-function camelify (str) {
-  return str[0] === '_'
-    ? '_' + str.slice(1).replace(/_([a-z])/g, k => k[1].toUpperCase())
-    : str.replace(/_([a-z])/g, k => k[1].toUpperCase())
-}
-
-function isSnakeCased (str) {
-  return !!~str.indexOf('_')
-}
-
-module.exports = generateDocs

scripts/utils/generateMain.js

@@ -1,299 +0,0 @@
-/*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-/* eslint-disable no-template-curly-in-string  */
-/* eslint camelcase: 0 */
-
-'use strict'
-
-const { readdirSync } = require('fs')
-const { join } = require('path')
-const dedent = require('dedent')
-const deepmerge = require('deepmerge')
-
-function genFactory (folder, specFolder, namespaces) {
-  // get all the API files
-  // const apiFiles = readdirSync(folder)
-  const apiFiles = readdirSync(specFolder)
-    .filter(file => file !== '_common.json')
-    .filter(file => !file.includes('deprecated'))
-    .sort()
-  const types = apiFiles
-    .map(file => {
-      const name = file
-        .slice(0, -5)
-        .replace(/\.([a-z])/g, k => k[1].toUpperCase())
-        .replace(/_([a-z])/g, k => k[1].toUpperCase())
-
-      return file
-        .slice(0, -5) // remove `.json` extension
-        .split('.')
-        .reverse()
-        .reduce((acc, val) => {
-          const spec = readSpec(specFolder, file.slice(0, -5))
-          const isHead = isHeadMethod(spec, file.slice(0, -5))
-          const body = hasBody(spec, file.slice(0, -5))
-          const methods = acc === null ? buildMethodDefinition({ kibana: false }, val, name, body, isHead, spec) : null
-          const obj = {}
-          if (methods) {
-            for (const m of methods) {
-              obj[m.key] = m.val
-            }
-          } else {
-            obj[val] = acc
-            if (isSnakeCased(val)) {
-              obj[camelify(val)] = acc
-            }
-          }
-          return obj
-        }, null)
-    })
-    .reduce((acc, val) => deepmerge(acc, val), {})
-
-  const kibanaTypes = apiFiles
-    .map(file => {
-      const name = file
-        .slice(0, -5)
-        .replace(/\.([a-z])/g, k => k[1].toUpperCase())
-        .replace(/_([a-z])/g, k => k[1].toUpperCase())
-
-      return file
-        .slice(0, -5) // remove `.json` extension
-        .split('.')
-        .reverse()
-        .reduce((acc, val) => {
-          const spec = readSpec(specFolder, file.slice(0, -5))
-          const isHead = isHeadMethod(spec, file.slice(0, -5))
-          const body = hasBody(spec, file.slice(0, -5))
-          const methods = acc === null ? buildMethodDefinition({ kibana: true }, val, name, body, isHead, spec) : null
-          const obj = {}
-          if (methods) {
-            for (const m of methods) {
-              obj[m.key] = m.val
-            }
-          } else {
-            obj[camelify(val)] = acc
-          }
-          return obj
-        }, null)
-    })
-    .reduce((acc, val) => deepmerge(acc, val), {})
-
-  // serialize the type object
-  const typesStr = Object.keys(types)
-    .map(key => {
-      const line = `  ${key}: ${JSON.stringify(types[key], null, 4)}`
-      if (line.slice(-1) === '}') {
-        return line.slice(0, -1) + '  }'
-      }
-      return line
-    })
-    .join('\n')
-    // remove useless quotes and commas
-    .replace(/"/g, '')
-    .replace(/,$/gm, '')
-  const kibanaTypesStr = Object.keys(kibanaTypes)
-    .map(key => {
-      const line = `  ${key}: ${JSON.stringify(kibanaTypes[key], null, 4)}`
-      if (line.slice(-1) === '}') {
-        return line.slice(0, -1) + '  }'
-      }
-      return line
-    })
-    .join('\n')
-    // remove useless quotes and commas
-    .replace(/"/g, '')
-    .replace(/,$/gm, '')
-
-  let apisStr = ''
-  const getters = []
-  for (const namespace in namespaces) {
-    if (namespaces[namespace].length > 0) {
-      getters.push(`${camelify(namespace)}: {
-        get () {
-          if (this[k${toPascalCase(camelify(namespace))}] === null) {
-            this[k${toPascalCase(camelify(namespace))}] = new ${toPascalCase(camelify(namespace))}Api(this.transport, this[kConfigurationError])
-          }
-          return this[k${toPascalCase(camelify(namespace))}]
-        }
-      },\n`)
-      if (namespace.includes('_')) {
-        getters.push(`${namespace}: { get () { return this.${camelify(namespace)} } },\n`)
-      }
-    } else {
-      apisStr += `ESAPI.prototype.${camelify(namespace)} = ${camelify(namespace)}Api\n`
-      if (namespace.includes('_')) {
-        getters.push(`${namespace}: { get () { return this.${camelify(namespace)} } },\n`)
-      }
-    }
-  }
-
-  apisStr += '\nObject.defineProperties(ESAPI.prototype, {\n'
-  for (const getter of getters) {
-    apisStr += getter
-  }
-  apisStr += '})'
-
-  let modules = ''
-  let symbols = ''
-  let symbolsInstance = ''
-  for (const namespace in namespaces) {
-    if (namespaces[namespace].length > 0) {
-      modules += `const ${toPascalCase(camelify(namespace))}Api = require('./api/${namespace}')\n`
-      symbols += `const k${toPascalCase(camelify(namespace))} = Symbol('${toPascalCase(camelify(namespace))}')\n`
-      symbolsInstance += `this[k${toPascalCase(camelify(namespace))}] = null\n`
-    } else {
-      modules += `const ${camelify(namespace)}Api = require('./api/${namespace}')\n`
-    }
-  }
-
-  const fn = dedent`
-  /*
-   * Licensed to Elasticsearch B.V. under one or more contributor
-   * license agreements. See the NOTICE file distributed with
-   * this work for additional information regarding copyright
-   * ownership. Elasticsearch B.V. licenses this file to you under
-   * the Apache License, Version 2.0 (the "License"); you may
-   * not use this file except in compliance with the License.
-   * You may obtain a copy of the License at
-   *
-   *    http://www.apache.org/licenses/LICENSE-2.0
-   *
-   * Unless required by applicable law or agreed to in writing,
-   * software distributed under the License is distributed on an
-   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-   * KIND, either express or implied.  See the License for the
-   * specific language governing permissions and limitations
-   * under the License.
-   */
-
-  'use strict'
-
-  ${modules}
-
-  const { kConfigurationError } = require('./utils')
-  ${symbols}
-
-  function ESAPI (opts) {
-    this[kConfigurationError] = opts.ConfigurationError
-    ${symbolsInstance}
-  }
-
-  ${apisStr}
-
-  module.exports = ESAPI
-  `
-
-  // new line at the end of file
-  return { fn: fn + '\n', types: typesStr, kibanaTypes: kibanaTypesStr }
-}
-
-// from snake_case to camelCase
-function camelify (str) {
-  return str.replace(/_([a-z])/g, k => k[1].toUpperCase())
-}
-
-function isSnakeCased (str) {
-  return !!~str.indexOf('_')
-}
-
-function toPascalCase (str) {
-  return str[0].toUpperCase() + str.slice(1)
-}
-
-function buildMethodDefinition (opts, api, name, hasBody, isHead, spec) {
-  const Name = toPascalCase(name)
-  const { content_type } = spec[Object.keys(spec)[0]].headers
-  const bodyType = content_type && content_type.includes('application/x-ndjson') ? 'RequestNDBody' : 'RequestBody'
-  const responseType = isHead ? 'boolean' : 'Record<string, any>'
-  const defaultBodyType = content_type && content_type.includes('application/x-ndjson') ? 'Record<string, any>[]' : 'Record<string, any>'
-
-  if (opts.kibana) {
-    if (hasBody) {
-      return [
-        { key: `${camelify(api)}<TResponse = ${responseType}, TRequestBody extends ${bodyType} = ${defaultBodyType}, TContext = Context>(params?: RequestParams.${Name}<TRequestBody>, options?: TransportRequestOptions)`, val: 'TransportRequestPromise<ApiResponse<TResponse, TContext>>' }
-      ]
-    } else {
-      return [
-        { key: `${camelify(api)}<TResponse = ${responseType}, TContext = Context>(params?: RequestParams.${Name}, options?: TransportRequestOptions)`, val: 'TransportRequestPromise<ApiResponse<TResponse, TContext>>' }
-      ]
-    }
-  }
-
-  if (hasBody) {
-    let methods = [
-      { key: `${api}<TResponse = ${responseType}, TRequestBody extends ${bodyType} = ${defaultBodyType}, TContext = Context>(params?: RequestParams.${Name}<TRequestBody>, options?: TransportRequestOptions)`, val: 'TransportRequestPromise<ApiResponse<TResponse, TContext>>' },
-      { key: `${api}<TResponse = ${responseType}, TRequestBody extends ${bodyType} = ${defaultBodyType}, TContext = Context>(callback: callbackFn<TResponse, TContext>)`, val: 'TransportRequestCallback' },
-      { key: `${api}<TResponse = ${responseType}, TRequestBody extends ${bodyType} = ${defaultBodyType}, TContext = Context>(params: RequestParams.${Name}<TRequestBody>, callback: callbackFn<TResponse, TContext>)`, val: 'TransportRequestCallback' },
-      { key: `${api}<TResponse = ${responseType}, TRequestBody extends ${bodyType} = ${defaultBodyType}, TContext = Context>(params: RequestParams.${Name}<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>)`, val: 'TransportRequestCallback' }
-    ]
-    if (isSnakeCased(api)) {
-      methods = methods.concat([
-        { key: `${camelify(api)}<TResponse = ${responseType}, TRequestBody extends ${bodyType} = ${defaultBodyType}, TContext = Context>(params?: RequestParams.${Name}<TRequestBody>, options?: TransportRequestOptions)`, val: 'TransportRequestPromise<ApiResponse<TResponse, TContext>>' },
-        { key: `${camelify(api)}<TResponse = ${responseType}, TRequestBody extends ${bodyType} = ${defaultBodyType}, TContext = Context>(callback: callbackFn<TResponse, TContext>)`, val: 'TransportRequestCallback' },
-        { key: `${camelify(api)}<TResponse = ${responseType}, TRequestBody extends ${bodyType} = ${defaultBodyType}, TContext = Context>(params: RequestParams.${Name}<TRequestBody>, callback: callbackFn<TResponse, TContext>)`, val: 'TransportRequestCallback' },
-        { key: `${camelify(api)}<TResponse = ${responseType}, TRequestBody extends ${bodyType} = ${defaultBodyType}, TContext = Context>(params: RequestParams.${Name}<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>)`, val: 'TransportRequestCallback' }
-      ])
-    }
-    return methods
-  } else {
-    let methods = [
-      { key: `${api}<TResponse = ${responseType}, TContext = Context>(params?: RequestParams.${Name}, options?: TransportRequestOptions)`, val: 'TransportRequestPromise<ApiResponse<TResponse, TContext>>' },
-      { key: `${api}<TResponse = ${responseType}, TContext = Context>(callback: callbackFn<TResponse, TContext>)`, val: 'TransportRequestCallback' },
-      { key: `${api}<TResponse = ${responseType}, TContext = Context>(params: RequestParams.${Name}, callback: callbackFn<TResponse, TContext>)`, val: 'TransportRequestCallback' },
-      { key: `${api}<TResponse = ${responseType}, TContext = Context>(params: RequestParams.${Name}, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>)`, val: 'TransportRequestCallback' }
-    ]
-    if (isSnakeCased(api)) {
-      methods = methods.concat([
-        { key: `${camelify(api)}<TResponse = ${responseType}, TContext = Context>(params?: RequestParams.${Name}, options?: TransportRequestOptions)`, val: 'TransportRequestPromise<ApiResponse<TResponse, TContext>>' },
-        { key: `${camelify(api)}<TResponse = ${responseType}, TContext = Context>(callback: callbackFn<TResponse, TContext>)`, val: 'TransportRequestCallback' },
-        { key: `${camelify(api)}<TResponse = ${responseType}, TContext = Context>(params: RequestParams.${Name}, callback: callbackFn<TResponse, TContext>)`, val: 'TransportRequestCallback' },
-        { key: `${camelify(api)}<TResponse = ${responseType}, TContext = Context>(params: RequestParams.${Name}, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>)`, val: 'TransportRequestCallback' }
-      ])
-    }
-    return methods
-  }
-}
-
-function hasBody (spec, api) {
-  return !!spec[api].body
-}
-
-function isHeadMethod (spec, api) {
-  const { paths } = spec[api].url
-  const methods = []
-  for (const path of paths) {
-    for (const method of path.methods) {
-      if (!methods.includes(method)) {
-        methods.push(method)
-      }
-    }
-  }
-  return methods.length === 1 && methods[0] === 'HEAD'
-}
-
-function readSpec (specFolder, file) {
-  try {
-    return require(join(specFolder, file))
-  } catch (err) {
-    throw new Error(`Cannot read spec file ${file}`)
-  }
-}
-
-module.exports = genFactory