Release notes from neo4j-javascript-driver

6.0.0-alpha01

2025-07-16T12:36:57Z

6.0.0-alpha01

⚠️ This is an experimental release. It may completely change in the future.
It is not guaranteed to include all breaking changes that will be present in 6.0.0

The main goal of this release is to offer a preview for new driver Vector type.

⭐ New Features

Support for Bolt 6.0 and the neo4j Vector type has been added. #1293
ResultTransformers .eager() and .mapped() have been marked stable. #1287
GQLStatusObjects have been stabilized as a replacement for the deprecated Notifications. #1285
The GQL-compliant properties gqlStatus, gqlStatusDescription, diagnosticRecord, classification and rawClassification on Neo4jError and GQLError have been stabilized. #1286

👏 Improvements

Added documentation to members of GQLError and Neo4jError. #1300
The timeout set with the connectionAcquisitionTimeout config option now covers the whole process of acquiring a connection, including preceding routing calls. This is to align with the behavior of other languages. #1292
Duration toString() format has been updated to align with the stringification in Cypher. #1284

🔧 Fixes

The seconds and nanoseconds properties on Duration objects will now not be neo4j.Integer typed if the driver is configured to return native JS numbers or BigInts. #1265

❌ Removals

severity has been removed from the Notification class. #1289

👎 Deprecation

Deprecated Date.toStandardDate() due to the unclear handling of timezones. Date.toStandardDateLocal() is a drop in replacement, but Date.toStandardDateUTC() may be more desireable to some users. #1290
ResultTransformers .eagerResultsTransformer() and .mappedResultsTransformer() have been deprecated. .eager() and .mapped() are drop in replacements. #1287
Notifications and related functions have been deprecated in favor of the newly stabilized GQLStatusObjects. #1285

5.28.1

2025-02-12T15:54:02Z

Patch release fixing the new handshake for some potential future bolt protocol versions.

🔧 Fixes

Fix handshake manifest parsing in preparation of future bolt versions. #1253

5.28.0

2025-02-05T12:09:52Z

Implements caching of home databases, saving significant round trips, primarily for usage against Aura, along with improved error handling, DateTime conversion and a new handshake protocol.

👏🏼 Improvements

Adds background caching of home databases, saving up to 33% of round trips when the user does not specify a target database. #1235
Implements a new handshake protocol for Bolt, allowing more granular selection of protocol versions in the future. #1243

🔧 Fixes

Improve handling and error communication when the user supplies a circular object in a custom auth token. #1247
Fix the conversion between driver and JavaScript DateTimes when the local timezone has rare minute offsets from UTC. #1238

5.27.0

2025-02-05T13:37:11Z

Takes mTLS authentication out of preview and improves some aspects of documentation.

⭐ New Features

Mutual TLS (mTLS) is marked stable and released out of preview #1237

🧹 Housekeeping

Marks the isUnboundRelationship function as private in documentation. #1234
Corrects the usage of the link tag in documentation, fixing some broken links. #1236
Adds notice regarding CALL {} IN TRANSACTION to executeRead and executeWrite. #1236

5.26.0

2025-02-05T13:14:30Z

Adds GQL compliant fields to the Neo4jError object as a preview feature.

⭐ New Features

Added GQL compliant fields to the Neo4jError object. #1225

🧹 Housekeeping

Marked JavaScripts treatment of Integers and Floats as Number as a Feature for testkit. #1228

5.25.0

2024-09-26T09:29:01Z

Housekeeping only.

🧹 Housekeeping

Remove DNS caching from testkit browser tests, reducing flakiness #1224
Improvements on error handling #1220

5.24.1

2024-09-05T11:39:10Z

Fix critical issue related to connection pool size enforcement. Along with this, other fixes related to connection error treatment are released.

🔧 Fixes

Remove un-predictable behaviour on connection failure due to multiple notification of same error #1213
Fix cases where the connection is destroyed on node, but the onclose event is not triggered #1215
Fix maxConnectionPoolSize verification #1216

5.24.0

2024-08-29T14:12:46Z

Added support for the new Schema notification category, and a minor fix to stop Deno tests from failing when run locally

⭐ New Features

Added Schema notification category #1211

🧹 Housekeeping

Move Pool module to core #1212
Fix to npm test crashing at Deno tests when running test containers #1210

5.23.0

2024-07-25T10:26:52Z

This fix a potential issue in the Notification api.

🔧 Fixes

Fix Notification.description polyfill from GqlStatusObject #1205

🧹 Housekeeping

Improve pipelines stability #1206

5.22.0

2024-06-27T14:20:08Z

This release introduces preview support to the GQLStatusObject #1194 along with other ergonomic preview features. This also speeds up the driver shutdown when connections are waiting to be acquired #1196, thanks, CarsonF, for the contribution.

⭐ ⚠️ Preview Features

Introduce GqlStatusObject support as notifications to ResultSummary #1194
Introduce AbortSignal to Driver.executeQuery 1199
Introduce resultTransformer.first #1200
Introduce resultTransformer.summary 1201
Introduce resultTransformers.eager and resultTransformers.mapped 1202

🔧 Fixes

Don't prevent NodeJS from closing to run acquisition timeout error #1196. Thanks, CarsonF.

🧹 Housekeeping

Improvements on internal APIs #1195