neo4j-driver 5.26.0 → 5.27.0

package/lib/browser/neo4j-web.esm.js

@@ -3221,6 +3221,7 @@ Object.defineProperty(UnboundRelationship.prototype, UNBOUND_RELATIONSHIP_IDENTI
  * 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);
@@ -9136,7 +9137,7 @@ Object.defineProperty(transactionPromise, "__esModule", { value: true });
 /* 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.
  *
@@ -9598,7 +9599,7 @@ var Session = /** @class */ (function () {
     /**
      * 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}
@@ -9639,7 +9640,7 @@ var Session = /** @class */ (function () {
      * 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}.
@@ -9660,7 +9661,7 @@ var Session = /** @class */ (function () {
      * 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}.
@@ -9685,6 +9686,10 @@ var Session = /** @class */ (function () {
      * 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.
@@ -9703,6 +9708,10 @@ var Session = /** @class */ (function () {
      * 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.
@@ -12174,7 +12183,7 @@ var Config = /** @class */ (function () {
          */
         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.
          *
@@ -12223,8 +12232,7 @@ var Config = /** @class */ (function () {
          * 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;
     }
@@ -12330,8 +12338,7 @@ var json = __importStar$5(json$3);
  *
  * @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() {
@@ -12360,8 +12367,8 @@ clientCertificate.default = ClientCertificate;
 /**
  * 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.
@@ -12373,8 +12380,7 @@ clientCertificate.default = ClientCertificate;
  * 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() {
@@ -12390,7 +12396,7 @@ var ClientCertificateProvider = /** @class */ (function () {
     /**
      * 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
@@ -12404,8 +12410,7 @@ clientCertificate.ClientCertificateProvider = ClientCertificateProvider;
 /**
  * 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);
@@ -12429,8 +12434,7 @@ clientCertificate.RotatingClientCertificateProvider = RotatingClientCertificateP
 /**
  * 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() {
@@ -12456,8 +12460,7 @@ var ClientCertificateProviders = /** @class */ (function () {
 /**
  * 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;
@@ -20959,7 +20962,7 @@ var RxResult = /** @class */ (function () {
      *
      * 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.
      */
@@ -21856,7 +21859,7 @@ Object.defineProperty(version$1, "__esModule", { value: true });
 // 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 = {};