Bump @opensearch-project/opensearch from 2.11.0 to 3.1.0

[dependabot]

Bumps @opensearch-project/opensearch from 2.11.0 to 3.1.0.

Release notes

Sourced from @​opensearch-project/opensearch's releases.

3.1.0

What's Changed

• [AUTOCUT] Update opensearch-js to reflect the latest OpenSearch API spec (2025-01-09) by @​opensearch-trigger-bot in opensearch-project/opensearch-js#958
• [AUTOCUT] Update opensearch-js to reflect the latest OpenSearch API spec (2025-01-09) by @​opensearch-trigger-bot in opensearch-project/opensearch-js#959
• Component types export by @​xfournet in opensearch-project/opensearch-js#957
• Version Bump for 3.1.0 Release by @​nhtruong in opensearch-project/opensearch-js#960

New Contributors

• @​xfournet made their first contribution in opensearch-project/opensearch-js#957

Full Changelog: opensearch-project/opensearch-js@3.0.0...3.1.0

3.0.0

We are excited to announce the release of OpenSearch JS Client 3.0.0. Through an API generator, the client has received a major overhaul for better readability, consistency, and most importantly a more complete and accurate interface to interact with OpenSearch clusters.

Automatically Updated API Functions:

Right off the bat, version 3.0.0 comes loaded with over a hundred new API functions compared to the previous 2.13.0 version, all generated from the OpenSearch API specification which currently covers about 60% of the OpenSearch API. All existing API functions have also been updated to match the latest spec. We also include a GitHub workflow that automatically updates the client every week, ensuring that the client is always up-to-date with the latest OpenSearch API. That means you don't have to wait long to try new OpenSearch features through this client.

For client maintainers, this means less tedious work to keep the client up-to-date with the spec. We now can focus on improving the client's performance, stability, adding new features, and filling in the missing APIs by adding them to the API specification. This also results in fewer issues related to outdated API functions, reducing headaches for both maintainers and users.

TypeScript support:

Previous versions of the client came with an incomplete and outdated set of request and response types that were written by hand. This issue has been resolved with 3.0.0 as these handwritten types have been replaced with types generated from the OpenSearch API specification. The new type definitions are written in a way that makes it a lot easier for IDEs and AI/ML assistants to provide autocomplete and type checking. This greatly improves the developer experience for TypeScript users: faster development and fewer bugs.

Removing Support for Outdated Features:

A major update is also an opportunity to remove outdated features that are no longer necessary or have been replaced by better alternatives:

• The client no longer allows overriding the HTTP method for API functions. In previous versions, some API functions let you pass method as a parameter to the API functions to override the default HTTP method. Now, method will be considered a querystring param, and using it will likely result in an error. If you need to send a custom request, you should use the client.http namespace.
• The client no longer supports camelCase parameters. Every API function now only accepts parameters matching the OpenSearch API Spec, which are also what the OpenSearch server expects.
• Support of Node.js 10 and 12 has been dropped. The client now requires Node.js 14 or higher. We strongly encourage users to upgrade to the latest LTS version of Node.js.

As with many major upgrades, the above-mentioned changes and the new comprehensive, precise and stricter typing system introduce some unavoidable breaking changes. For a complete list of changes and deprecations, please refer to the upgrading guide.

---

We hope you enjoy the new OpenSearch JS Client 3.0. We are excited to see what you build with it. If you have any questions or feedback, please don't hesitate to open an issue on the GitHub repository. We are always looking to improve the client and make it easier for you to interact with OpenSearch clusters.

3.0.0-beta.7

What's Changed

• Bump micromatch from 4.0.7 to 4.0.8 by @​dependabot in opensearch-project/opensearch-js#858
• Bump simple-statistics from 7.8.4 to 7.8.5 by @​dependabot in opensearch-project/opensearch-js#860
• Bump simple-git from 3.25.0 to 3.26.0 by @​dependabot in opensearch-project/opensearch-js#862
• Bump @​types/node from 22.5.0 to 22.5.2 by @​dependabot in opensearch-project/opensearch-js#861
• Bump aws4 from 1.13.1 to 1.13.2 by @​dependabot in opensearch-project/opensearch-js#865
• Bump @​types/node from 22.5.2 to 22.5.4 by @​dependabot in opensearch-project/opensearch-js#867
• Bump debug from 4.3.6 to 4.3.7 by @​dependabot in opensearch-project/opensearch-js#866
• Auto Generated API - 3.0.0 by @​nhtruong in opensearch-project/opensearch-js#864

... (truncated)

Changelog

Sourced from @​opensearch-project/opensearch's changelog.

[3.1.0]

Added

• Added export of component types (#955)

Dependencies

Changed

• Updated API to match the OpenSearch spec from Jan 09, 2025

Deprecated

Removed

Fixed

Security

[3.0.0]

Added

• Added API Generator (#789)
• Added missing API functions and modules.
• Added missing request and response types.

Changed

• All API functions are now generated from the OpenSearch API specification.
• API request and response types are now generated from the OpenSearch API specification.
• Overhauled API codebase and break it into smaller, more manageable files for better readability and maintainability.

Deprecated

• Support for snake_cased API function aliases have been deprecated to conform to JavaScript naming conventions.

Removed

• Removed support for API param aliases. That is, the API functions now only accept params with the exact names specified in the OpenSearch API specification.
• Removed support for overriding HTTP methods in API functions.
• Removed support for Node.js 10 and 12. The minimum supported Node.js version is now 14.

[2.13.0]

Dependencies

• Bumps @babel/traverse from 7.22.8 to 7.24.7
• Bumps @types/node from 22.5.0 to 22.5.4
• Bumps aws4 from 1.13.0 to 1.13.2
• Bumps aws4 from 1.13.1 to 1.13.2
• Bumps debug from 4.3.6 to 4.3.7
• Bumps eslint-plugin-prettier from 5.1.3 to 5.2.1
• Bumps micromatch from 4.0.7 to 4.0.8
• Bumps simple-git from 3.24.0 to 3.26.0
• Bumps simple-git from 3.25.0 to 3.26.0
• Bumps simple-statistics from 7.8.4 to 7.8.5

Fixed

• Upgrade JSON11 from 1.1.2 to 2.0.0 to ensure UTF-8 safety when stringifying JSON data
• Fixed typo cause JSON11 parse will always be executed when json string has number inside

[2.12.0]

Dependencies

• Bumps @babel/eslint-parser from 7.24.8 to 7.25.1
• Bumps @types/node from 20.14.11 to 22.5.0
• Bumps aws4 from 1.13.0 to 1.13.1
• Bumps ora from 8.0.1 to 8.1.0
• Bumps simple-statistics from 7.8.3 to 7.8.4

... (truncated)

Commits

• 2c3135f Version Bump for 3.1.0 Release (#960)
• faa8069 Component types export (#957)
• 180eaa0 [AUTOCUT] Update opensearch-js to reflect the latest OpenSearch API spec (202...
• a1fa1e6 [AUTOCUT] Update opensearch-js to reflect the latest OpenSearch API spec (202...
• f4c5f26 [AUTOCUT] Update opensearch-js to reflect the latest OpenSearch API spec (202...
• 8703a6c Version Bump for 3.0.0 Release (#949)
• 4fa3313 Bump lycheeverse/lychee-action from 2.1.0 to 2.2.0 (#947)
• 71e1108 [AUTOCUT] Update opensearch-js to reflect the latest OpenSearch API spec (202...
• 75c999b Changed Request and Response types into interfaces (#944)
• ce4a17f [AUTOCUT] Update opensearch-js to reflect the latest OpenSearch API spec (202...
• Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

---

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)