neo4j-driver 5.26.0 → 5.27.0

package/lib/browser/neo4j-web.js

@@ -3227,6 +3227,7 @@
 	 * Test if given object is an instance of {@link UnboundRelationship} class.
 	 * @param {Object} obj the object to test.
 	 * @return {boolean} `true` if given object is a {@link UnboundRelationship}, `false` otherwise.
+	 * @access private
 	 */
 	function isUnboundRelationship(obj) {
 	    return hasIdentifierProperty(obj, UNBOUND_RELATIONSHIP_IDENTIFIER_PROPERTY);
@@ -9142,7 +9143,7 @@
 	/* eslint-disable @typescript-eslint/promise-function-async */
 	var transaction_1 = __importDefault$U(transaction);
 	/**
-	 * Represents a {@link Promise<Transaction>} object and a {@link Transaction} object.
+	 * Represents a Promise<{@link Transaction}> object and a {@link Transaction} object.
 	 *
 	 * Resolving this object promise verifies the result of the transaction begin and returns the {@link Transaction} object in case of success.
 	 *
@@ -9604,7 +9605,7 @@
 	    /**
 	     * Return the bookmarks received following the last completed {@link Transaction}.
 	     *
-	     * @deprecated This method will be removed in version 6.0. Please, use Session#lastBookmarks instead.
+	     * @deprecated This method will be removed in version 6.0. Please, use {@link Session#lastBookmarks} instead.
 	     *
 	     * @return {string[]} A reference to a previous transaction.
 	     * @see {@link Session#lastBookmarks}
@@ -9645,7 +9646,7 @@
 	     * delay of 1 second and maximum retry time of 30 seconds. Maximum retry time is configurable via driver config's
 	     * `maxTransactionRetryTime` property in milliseconds.
 	     *
-	     * @deprecated This method will be removed in version 6.0. Please, use Session#executeRead instead.
+	     * @deprecated This method will be removed in version 6.0. Please, use {@link Session#executeRead} instead.
 	     *
 	     * @param {function(tx: Transaction): Promise} transactionWork - Callback that executes operations against
 	     * a given {@link Transaction}.
@@ -9666,7 +9667,7 @@
 	     * delay of 1 second and maximum retry time of 30 seconds. Maximum retry time is configurable via driver config's
 	     * `maxTransactionRetryTime` property in milliseconds.
 	     *
-	     * @deprecated This method will be removed in version 6.0. Please, use Session#executeWrite instead.
+	     * @deprecated This method will be removed in version 6.0. Please, use {@link Session#executeWrite} instead.
 	     *
 	     * @param {function(tx: Transaction): Promise} transactionWork - Callback that executes operations against
 	     * a given {@link Transaction}.
@@ -9691,6 +9692,10 @@
 	     * delay of 1 second and maximum retry time of 30 seconds. Maximum retry time is configurable via driver config's
 	     * `maxTransactionRetryTime` property in milliseconds.
 	     *
+	     * NOTE: Because it is an explicit transaction from the server point of view, Cypher queries using
+	     * "CALL {} IN TRANSACTIONS" or the older "USING PERIODIC COMMIT" construct will not work (call
+	     * {@link Session#run} for these).
+	     *
 	     * @param {function(tx: ManagedTransaction): Promise} transactionWork - Callback that executes operations against
 	     * a given {@link Transaction}.
 	     * @param {TransactionConfig} [transactionConfig] - Configuration for all transactions started to execute the unit of work.
@@ -9709,6 +9714,10 @@
 	     * delay of 1 second and maximum retry time of 30 seconds. Maximum retry time is configurable via driver config's
 	     * `maxTransactionRetryTime` property in milliseconds.
 	     *
+	     * NOTE: Because it is an explicit transaction from the server point of view, Cypher queries using
+	     * "CALL {} IN TRANSACTIONS" or the older "USING PERIODIC COMMIT" construct will not work (call
+	     * {@link Session#run} for these).
+	     *
 	     * @param {function(tx: ManagedTransaction): Promise} transactionWork - Callback that executes operations against
 	     * a given {@link Transaction}.
 	     * @param {TransactionConfig} [transactionConfig] - Configuration for all transactions started to execute the unit of work.
@@ -12180,7 +12189,7 @@
 	         */
 	        this.resolver = undefined;
 	        /**
-	         * Configure filter for Notification objects returned in {@Link ResultSummary#notifications}.
+	         * Configure filter for Notification objects returned in {@link ResultSummary#notifications}.
 	         *
 	         * See {@link SessionConfig#notificationFilter} for usage instructions.
 	         *
@@ -12229,8 +12238,7 @@
 	         * where the {@link ClientCertificate} might change over time.
 	         *
 	         * @type {ClientCertificate|ClientCertificateProvider|undefined}
-	         * @experimental Exposed as preview feature.
-	         * @since 5.19
+	         * @since 5.27
 	         */
 	        this.clientCertificate = undefined;
 	    }
@@ -12336,8 +12344,7 @@
 	 *
 	 * @interface
 	 * @see https://nodejs.org/api/tls.html#tlscreatesecurecontextoptions
-	 * @experimental Exposed as preview feature.
-	 * @since 5.19
+	 * @since 5.27
 	 */
 	var ClientCertificate = /** @class */ (function () {
 	    function ClientCertificate() {
@@ -12366,8 +12373,8 @@
 	/**
 	 * Provides a client certificate to the driver for mutual TLS.
 	 *
-	 * The driver will call {@link ClientCertificateProvider#hasUpdate()} to check if the client wants to update the certificate.
-	 * If so, it will call {@link ClientCertificateProvider#getCertificate()} to get the new certificate.
+	 * The driver will call {@link ClientCertificateProvider#hasUpdate} to check if the client wants to update the certificate.
+	 * If so, it will call {@link ClientCertificateProvider#getClientCertificate} to get the new certificate.
 	 *
 	 * The certificate is only used as a second factor for authentication authenticating the client.
 	 * The DMBS user still needs to authenticate with an authentication token.
@@ -12379,8 +12386,7 @@
 	 * Should fetching the certificate be particularly slow, it might be necessary to increase the timeout.
 	 *
 	 * @interface
-	 * @experimental Exposed as preview feature.
-	 * @since 5.19
+	 * @since 5.27
 	 */
 	var ClientCertificateProvider = /** @class */ (function () {
 	    function ClientCertificateProvider() {
@@ -12396,7 +12402,7 @@
 	    /**
 	     * Returns the certificate to use for new connections.
 	     *
-	     * Will be called by the driver after {@link ClientCertificateProvider#hasUpdate()} returned true
+	     * Will be called by the driver after {@link ClientCertificateProvider#hasUpdate} returned true
 	     * or when the driver establishes the first connection.
 	     *
 	     * @returns {Promise<ClientCertificate>|ClientCertificate} the certificate to use for new connections
@@ -12410,8 +12416,7 @@
 	/**
 	 * Interface for  {@link ClientCertificateProvider} which provides update certificate function.
 	 * @interface
-	 * @experimental Exposed as preview feature.
-	 * @since 5.19
+	 * @since 5.27
 	 */
 	var RotatingClientCertificateProvider = /** @class */ (function (_super) {
 	    __extends$M(RotatingClientCertificateProvider, _super);
@@ -12435,8 +12440,7 @@
 	/**
 	 * Defines the object which holds the common {@link ClientCertificateProviders} used in the Driver
 	 *
-	 * @experimental Exposed as preview feature.
-	 * @since 5.19
+	 * @since 5.27
 	 */
 	var ClientCertificateProviders = /** @class */ (function () {
 	    function ClientCertificateProviders() {
@@ -12462,8 +12466,7 @@
 	/**
 	 * Holds the common {@link ClientCertificateProviders} used in the Driver.
 	 *
-	 * @experimental Exposed as preview feature.
-	 * @since 5.19
+	 * @since 5.27
 	 */
 	var clientCertificateProviders = new ClientCertificateProviders();
 	clientCertificate.clientCertificateProviders = clientCertificateProviders;
@@ -20965,7 +20968,7 @@
 	     *
 	     * This method won't need to be called in normal stream operation. It only applies to the case when the stream is paused.
 	     *
-	     * This method is method won't start the consuming records if the ${@link records()} stream didn't get subscribed.
+	     * This method is method won't start the consuming records if the {@link records} stream didn't get subscribed.
 	     * @experimental
 	     * @returns {Promise<void>} - A promise that resolves when the stream is resumed.
 	     */
@@ -21862,7 +21865,7 @@
 	// This is set up this way to keep the version in the code in
 	// sync with the npm package version, and to allow the build
 	// system to control version names at packaging time.
-	version$1.default = '5.26.0';
+	version$1.default = '5.27.0';
 
 	var lib = {};