npm / @opensearch-project/opensearch
@opensearch-project/opensearch
What changed in @opensearch-project/opensearch 2 to 3, from its official release notes, upgrade guides and advisories. Sources checked 2026-11-13.
9 breaking3 security1 deprecations2 new APIs and options1 performance1 behavior and defaults1 tooling2 fixes and other
See which of these apply to your code, ranked, in your agent:
npx @unstale/cli init@opensearch-project/opensearch 314 changes
Breaking changes 5
Decompression is capped, limiting the amount of decompressed response data the client processes.
Declares the Connection agent property as agent rather than _agent.
API functions no longer accept camelCase parameters and accept only parameters matching the OpenSearch API specification.
API functions no longer allow overriding the HTTP method; method is treated as a querystring parameter. Use the client.http namespace for custom requests.
The client requires Node.js 14 or higher; support for Node.js 10 and 12 has been dropped.
Security 2
Response size limits are applied when Content-Length is absent, protecting users from oversized responses without that header.
Fixed SigV4 signing so the x-amz-content-sha256 header is signed.
New APIs and options 2
Adds support for overwriting the host header.
Over a hundred API functions were added, and existing functions were updated to match the latest OpenSearch API specification.
Performance 1
API namespaces are instantiated lazily to improve Client construction performance.
Behavior and default changes 1
The client was updated to reflect the latest OpenSearch API specification, potentially changing the API operations available to developers.
Tooling 1
Handwritten request and response types were replaced with types generated from the OpenSearch API specification, improving autocomplete and type checking.
Fixes and other changes 2
Fixes handling of mixed operations in the bulk helper.
The error listener was added back before the callback.
@opensearch-project/opensearch 26 changes
Breaking changes 4
The client changes its Blacklist / Whitelist terminology.
The remaining existsType references are removed.
The remaining flushSynced references are removed.
Types are removed for 2.0.
Security 1
Response size is bounded when Content-Length is absent, limiting the size of responses the client processes.
Deprecations 1
The client deprecates its Master terminology.