Backports to 9.3 (#3178)

* Bump to 9.3.1 (#3176)

* fix bundle issue (#3175)

---------

Co-authored-by: margaretjgu <136839162+margaretjgu@users.noreply.github.com>

Author: JoshMock

.github/workflows/nodejs.yml

@@ -123,3 +123,32 @@ jobs:
         shell: bash
         run: |
           [ "$CODE_CHANGED" = "true" ] && bun run test:esm || exit 0
+
+  test-bundler:
+    name: Test ESM bundle (Bun/Rolldown compatibility)
+    runs-on: ubuntu-latest
+    needs: paths-filter
+    env:
+      CODE_CHANGED: ${{ needs.paths-filter.outputs.src-only }}
+
+    steps:
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
+        with:
+          persist-credentials: false
+
+      - name: Use Node.js
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
+        with:
+          node-version: 24.x
+
+      - name: Install
+        run: npm install
+
+      - name: Bundler test (esbuild bundle + run)
+        shell: bash
+        run: |
+          if [ "$CODE_CHANGED" = "true" ]; then
+            npm run test:bundler;
+          else
+            exit 0;
+          fi

.gitignore

@@ -60,10 +60,12 @@ test/benchmarks/macro/fixtures/*
 .cache
 
 test/bundlers/**/bundle.js
+test/bundlers/**/bundled.js
 test/bundlers/parcel-test/.parcel-cache
 
 lib
 esm/
+src/version.generated.ts
 junit-output
 bun.lockb
 test-results

docs/release-notes/index.md

@@ -20,6 +20,13 @@ To check for security updates, go to [Security announcements for the Elastic sta
 % ### Fixes [elasticsearch-javascript-client-next-fixes]
 % \*
 
+## 9.3.1 [elasticsearch-javascript-client-9.3.1-release-notes]
+
+### Fixes [elasticsearch-javascript-client-9.3.1-fixes]
+
+- **Improved ESM compatibility:** Ensure `estypes` is exported for ESM-based projects, and that ESM modules work correctly for JavaScript bundlers.
+- **Improved compatibility with Elasticsearch 9.3:** improvements and corrections have been made to the Elasticsearch specification for 9.3 that are reflected here.
+
 ## 9.3.0 [elasticsearch-javascript-client-9.3.0-release-notes]
 
 ### Features and enhancements [elasticsearch-javascript-client-9.3.0-features-enhancements]

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@elastic/elasticsearch",
-  "version": "9.3.0",
-  "versionCanary": "9.3.0-canary.0",
+  "version": "9.3.1",
+  "versionCanary": "9.3.1-canary.0",
   "description": "The official Elasticsearch client for Node.js",
   "type": "commonjs",
   "main": "./index.js",
@@ -28,6 +28,7 @@
     "test": "npm run build && npm run lint && c8 --exclude='**/api/**' --exclude='**/test/**' --check-coverage --statements=96 --branches=90 --lines=96 --functions=88 tap --disable-coverage",
     "test:unit": "npm run build && tap",
     "test:unit-bun": "bun run build && bunx tap",
+    "test:bundler": "npm run build && cd test/bundlers/repro && npm install file:../../.. && npx esbuild@0.24 --bundle --platform=node repro.mjs --outfile=bundled.js && node bundled.js",
     "test:esm": "npm run build:esm && tap test/esm/",
     "test:coverage-100": "npm run build && tap --coverage --100",
     "test:coverage-report": "npm run build && tap --coverage && nyc report --reporter=text-lcov > coverage.lcov",
@@ -38,7 +39,8 @@
     "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",
+    "generate-version": "node scripts/generate-version.js",
+    "prebuild": "npm run clean-build && npm run generate-version && npm run lint",
     "build": "npm run build:cjs && npm run build:esm",
     "build:cjs": "tsc && rm -f lib/package.json lib/index.js lib/index.d.ts",
     "build:esm": "tsc -p tsconfig.esm.json && npm run build:esm-fix && npm run build:esm-package",
@@ -113,7 +115,7 @@
     "zx": "8.8.0"
   },
   "dependencies": {
-    "@elastic/transport": "^9.3.2",
+    "@elastic/transport": "^9.3.3",
     "apache-arrow": "18.x - 21.x",
     "tslib": "^2.4.0"
   }

scripts/generate-version.js

@@ -0,0 +1,34 @@
+#!/usr/bin/env node
+/*
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const fs = require('fs')
+const path = require('path')
+
+const rootDir = path.join(__dirname, '..')
+const clientPkg = JSON.parse(fs.readFileSync(path.join(rootDir, 'package.json'), 'utf8'))
+let transportVersion = '0.0.0'
+try {
+  const transportPkgPath = require.resolve('@elastic/transport/package.json', { paths: [rootDir] })
+  const transportPkg = JSON.parse(fs.readFileSync(transportPkgPath, 'utf8'))
+  transportVersion = transportPkg.version
+} catch (_) {
+  // @elastic/transport not installed (e.g. pre-install); use placeholder 0.0.0
+}
+
+const outPath = path.join(rootDir, 'src', 'version.generated.ts')
+const content = `/*
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Generated by scripts/generate-version.js - do not edit manually.
+ */
+
+export const clientVersion: string = '${clientPkg.version}'
+export const transportVersion: string = '${transportVersion}'
+`
+
+fs.writeFileSync(outPath, content, 'utf8')
+console.log(`Generated ${outPath} (client: ${clientPkg.version}, transport: ${transportVersion})`)

src/client.ts

@@ -37,23 +37,19 @@ import SniffingTransport from './sniffingTransport'
 import Helpers from './helpers'
 import API from './api'
 import { kAcceptedParams } from './symbols'
-
-/* eslint-disable @typescript-eslint/no-var-requires */
-const packageJson = require('../package.json')
-const transportPackageJson = require('@elastic/transport/package.json')
-/* eslint-enable @typescript-eslint/no-var-requires */
+import { clientVersion as rawClientVersion, transportVersion as rawTransportVersion } from './version.generated'
 
 const kChild = Symbol('elasticsearchjs-child')
 const kInitialOptions = Symbol('elasticsearchjs-initial-options')
 export { kAcceptedParams }
 
-let clientVersion: string = packageJson.version
+let clientVersion: string = rawClientVersion
 /* istanbul ignore next */
 if (clientVersion.includes('-')) {
   // clean prerelease
   clientVersion = clientVersion.slice(0, clientVersion.indexOf('-')) + 'p'
 }
-let transportVersion: string = transportPackageJson.version // eslint-disable-line
+let transportVersion: string = rawTransportVersion
 /* istanbul ignore next */
 if (transportVersion.includes('-')) {
   // clean prerelease

test/bundlers/repro/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "repro",
+  "private": true,
+  "version": "1.0.0",
+  "description": "Minimal repro for ESM bundling regression",
+  "license": "Apache-2.0",
+  "type": "commonjs",
+  "dependencies": {
+    "@elastic/elasticsearch": "file:../../.."
+  }
+}

test/bundlers/repro/repro.mjs

@@ -0,0 +1,9 @@
+/*
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { Client } from "@elastic/elasticsearch"
+const c = new Client({ node: "http://localhost:9200" })
+console.log("Client created:", typeof c)
+process.exit(0)