Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(deps): Bump @opensearch-project/opensearch from 2.13.0 to 3.0.0 #1726

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Jan 7, 2025

Bumps @opensearch-project/opensearch from 2.13.0 to 3.0.0.

Release notes

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

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, all generated from the OpenSearch API specification. 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 our 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, and adding new features. This also results in much 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 to provide auto-completion and type checking. This greatly improves the developer experience for TypeScript users: faster development and fewer bugs.

However, this new comprehensive and precise typing system also introduces some breaking changes as it is stricter and with different ways of accessing the type definitions. Checkout the upgrading guide for more details.

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.
  • 3.0.0 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.

For a complete list of breaking changes and deprecations, please refer to the upgrading guide.


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

3.0.0-beta.7

What's Changed

Full Changelog: opensearch-project/opensearch-js@2.12.0...3.0.0-beta.7

3.0.0-beta.6

What's Changed

... (truncated)

Changelog

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

[3.0.0]

Added

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

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

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.

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

Security

[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

Fixed

  • Fixed docker-compose command in Makefile (#845)

[2.11.0]

Changed

  • Return a transport object from AwsSigv4SignerTransport.request that has an .abort() method that allows in-flight requests to be canceled

Dependencies

  • Bumps @aws-sdk/types from 3.577.0 to 3.609.0
  • Bumps @babel/eslint-parser from 7.24.7 to 7.24.8
  • Bumps @types/node from20.14.2 to 20.14.11
  • Bumps eslint-plugin-prettier from 5.1.3 to 5.2.1
  • Bumps faker from 5.5.3 to 6.6.6

... (truncated)

Commits
  • 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...
  • 4ce1fe3 Fix document_lifecycle.md (#937)
  • fc7bc20 Added Miki to the maintainers list. (#935)
  • 4ae6093 [AUTOCUT] Update opensearch-js to reflect the latest OpenSearch API spec (202...
  • 87c8ea8 Bump lycheeverse/lychee-action from 1.5.0 to 2.1.0 (#928)
  • Additional commits viewable in compare view

Dependabot compatibility score

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)

Bumps [@opensearch-project/opensearch](https://github.com/opensearch-project/opensearch-js) from 2.13.0 to 3.0.0.
- [Release notes](https://github.com/opensearch-project/opensearch-js/releases)
- [Changelog](https://github.com/opensearch-project/opensearch-js/blob/main/CHANGELOG.md)
- [Commits](opensearch-project/opensearch-js@2.13.0...3.0.0)

---
updated-dependencies:
- dependency-name: "@opensearch-project/opensearch"
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file javascript Pull requests that update Javascript code labels Jan 7, 2025
Copy link
Contributor Author

dependabot bot commented on behalf of github Jan 13, 2025

A newer version of @​opensearch-project/opensearch exists, but since this PR has been edited by someone other than Dependabot I haven't updated it. You'll get a PR for the updated version as normal once this PR is merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file javascript Pull requests that update Javascript code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant