Skip to content

Commit ad904ec

Browse files
committed
chore: bump version to 3.0.0
Adds the 3.0.0 changelog entry with an explicit breaking-changes section covering the optional runtime dependencies that are no longer installed by the wrapper, the now-typed client constructors, and the removal of any from the external API.
1 parent 3000b56 commit ad904ec

7 files changed

Lines changed: 31 additions & 8 deletions

File tree

CHANGELOG.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,37 @@ All notable changes to this project will be documented in this file.
44

55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/#semantic-versioning-200).
66

7-
## [Unreleased]
7+
## [3.0.0] - 2026-08-20
8+
9+
### :boom: Breaking Changes
10+
11+
- Optional runtime dependencies are no longer installed for you. `@opentelemetry/api`, `http-cookie-agent` and `tough-cookie` moved from `dependencies` to optional `peerDependencies`, and the OpenTelemetry SDK packages (`@opentelemetry/context-async-hooks`, `@opentelemetry/resources`, `@opentelemetry/sdk-trace-base`, `@opentelemetry/semantic-conventions`) are no longer declared by the wrapper at all. Applications that use telemetry, or the [Federated Authentication](https://github.com/aws/aws-advanced-nodejs-wrapper/blob/main/docs/using-the-nodejs-wrapper/using-plugins/UsingTheFederatedAuthPlugin.md) and [Okta Authentication](https://github.com/aws/aws-advanced-nodejs-wrapper/blob/main/docs/using-the-nodejs-wrapper/using-plugins/UsingTheOktaAuthPlugin.md) plugins, must add the packages they need to their own dependencies.
12+
- Client constructors are typed. `AwsPgClient`, `AwsPgPoolClient`, `AwsMySQLClient` and `AwsMySQLPoolClient` now accept `AwsPgClientConfig` / `AwsMySQLClientConfig` in place of `any`, so TypeScript rejects unknown or misspelled connection properties at compile time. This is a compile-time change only; runtime behaviour is unchanged. Configurations that relied on the untyped parameter may need corrections.
13+
- `any` has been removed from the external API. Most visibly, `query()` on the MySQL clients now resolves to `[T, FieldPacket[]]` rather than `[T, any]`. Code that consumed those results loosely may need type updates.
14+
15+
### :magic_wand: Added
16+
17+
- Support for [Amazon Aurora Global Databases](https://github.com/aws/aws-advanced-nodejs-wrapper/blob/main/docs/using-the-nodejs-wrapper/GlobalDatabases.md), including in-region and cross-region failover, global writer endpoint recognition and stale DNS handling.
18+
- [Global Database Failover Plugin](https://github.com/aws/aws-advanced-nodejs-wrapper/blob/main/docs/using-the-nodejs-wrapper/using-plugins/UsingTheGlobalDbFailoverPlugin.md), which adds the notion of a home region and lets failover behaviour be configured separately for the in-home and out-of-home cases.
19+
- [Global Database Read/Write Splitting Plugin](https://github.com/aws/aws-advanced-nodejs-wrapper/blob/main/docs/using-the-nodejs-wrapper/using-plugins/UsingTheGlobalDbReadWriteSplittingPlugin.md), which can constrain new connections to a home region.
20+
- [Restricting Aurora Global Database access by region](https://github.com/aws/aws-advanced-nodejs-wrapper/blob/main/docs/using-the-nodejs-wrapper/using-plugins/UsingGlobalAuroraAccessibleRegions.md) with the `gdbAccessibleRegions` parameter.
21+
- [Monitoring connection priority](https://github.com/aws/aws-advanced-nodejs-wrapper/blob/main/docs/using-the-nodejs-wrapper/using-plugins/UsingMonitoringConnectionPriority.md), which directs the topology monitor's connection to a preferred host type or region.
22+
- Exported configuration types `AwsClientConfig`, `AwsPgClientConfig` and `AwsMySQLClientConfig`.
823

924
### :crab: Changed
1025

1126
- Renamed the PostgreSQL client to `AwsPgClient` and its pooled connection type to `AwsPgPooledConnection` for consistent `Pg` casing across the `pg` module. This is a non-breaking change.
27+
- PostgreSQL dialect queries are now schema-qualified, so they resolve correctly regardless of the session `search_path`.
1228

1329
### :warning: Deprecated
1430

1531
- `AwsPGClient` and `AwsPGPooledConnection` are now deprecated. They remain exported as backwards-compatible aliases of `AwsPgClient` and `AwsPgPooledConnection` and behave identically, so existing code continues to work without modification. Update imports to the new names; the deprecated aliases are scheduled for removal in the next major release.
1632

33+
### :bug: Fixed
34+
35+
- IAM, Federated Authentication and Okta authentication now work against Aurora MySQL. Aurora asks a token-authenticated user for the `mysql_clear_password` authentication plugin, which the underlying driver refuses unless `enableCleartextPlugin` is set; the wrapper now enables it when a token-based authentication plugin is in use and the connection is encrypted. See [MySQL requires an encrypted connection](https://github.com/aws/aws-advanced-nodejs-wrapper/blob/main/docs/using-the-nodejs-wrapper/using-plugins/UsingTheIamAuthenticationPlugin.md#mysql-requires-an-encrypted-connection).
36+
- Failover is now triggered by read-only connection errors when using `strict-writer` failover mode.
37+
1738
## [2.1.1] - 2026-05-28
1839

1940
### :magic_wand: Added

MAINTENANCE.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
| Oct 17 2025 | [Release 2.0.1](https://github.com/aws/aws-advanced-nodejs-wrapper/releases/tag/2.0.1) |
1111
| Jan 15 2026 | [Release 2.1.0](https://github.com/aws/aws-advanced-nodejs-wrapper/releases/tag/2.1.0) |
1212
| May 28 2026 | [Release 2.1.1](https://github.com/aws/aws-advanced-nodejs-wrapper/releases/tag/2.1.1) |
13+
| Aug 20 2026 | [Release 3.0.0](https://github.com/aws/aws-advanced-nodejs-wrapper/releases/tag/3.0.0) |
1314

1415
`aws-advanced-nodejs-wrapper` [follows semver](https://semver.org/#semantic-versioning-200) which means we will only
1516
release breaking changes in major versions. Generally speaking patches will be released to fix existing problems without
@@ -62,4 +63,5 @@ from the updated source after the PRs are merged.
6263
| Major Version | Latest Minor Version | Status | Initial Release | Maintenance Window Start | Maintenance Window End |
6364
| ------------- | -------------------- | ----------- | --------------- | ------------------------ | ---------------------- |
6465
| 1 | 1.3.0 | Maintenance | Nov 19, 2024 | Sep 11, 2025 | Sep 11, 2026 |
65-
| 2 | 2.1.1 | Current | Sep 11, 2025 | N/A | N/A |
66+
| 2 | 2.1.1 | Maintenance | Sep 11, 2025 | Aug 20, 2026 | Aug 20, 2027 |
67+
| 3 | 3.0.0 | Current | Aug 20, 2026 | N/A | N/A |

examples/javascript_example/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"start": "node index.js"
99
},
1010
"dependencies": {
11-
"aws-advanced-nodejs-wrapper": "^2.1.1",
11+
"aws-advanced-nodejs-wrapper": "^3.0.0",
1212
"pg": "^8.11.0"
1313
}
1414
}

examples/prisma_example/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
"dependencies": {
1919
"@prisma/client": "6.0.0",
2020
"@prisma/driver-adapter-utils": "^6.0.0",
21-
"aws-advanced-nodejs-wrapper": "^2.1.1",
21+
"aws-advanced-nodejs-wrapper": "^3.0.0",
2222
"pg": "^8.13.1",
2323
"util": "^0.12.5"
2424
}

examples/typescript_example/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"dev": "ts-node src/index.ts"
1111
},
1212
"dependencies": {
13-
"aws-advanced-nodejs-wrapper": "^2.1.1",
13+
"aws-advanced-nodejs-wrapper": "^3.0.0",
1414
"mysql2": "^3.6.0"
1515
},
1616
"devDependencies": {

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "aws-advanced-nodejs-wrapper",
3-
"version": "2.1.1",
3+
"version": "3.0.0",
44
"type": "module",
55
"engines": {
66
"node": ">=22.9.0",

0 commit comments

Comments
 (0)