neo4j-driver 5.9.0 → 5.9.1

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

@@ -30,7 +30,7 @@ var error = {};
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var __extends$K = (commonjsGlobal && commonjsGlobal.__extends) || (function () {
+var __extends$L = (commonjsGlobal && commonjsGlobal.__extends) || (function () {
     var extendStatics = function (d, b) {
         extendStatics = Object.setPrototypeOf ||
             ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
@@ -77,7 +77,7 @@ var NOT_AVAILABLE$1 = 'N/A';
  * Class for all errors thrown/returned by the driver.
  */
 var Neo4jError = /** @class */ (function (_super) {
-    __extends$K(Neo4jError, _super);
+    __extends$L(Neo4jError, _super);
     /**
      * @constructor
      * @param {string} message - the error message
@@ -4527,7 +4527,7 @@ var connectionHolder$1 = {};
  * limitations under the License.
  */
 /* eslint-disable @typescript-eslint/promise-function-async */
-var __extends$J = (commonjsGlobal && commonjsGlobal.__extends) || (function () {
+var __extends$K = (commonjsGlobal && commonjsGlobal.__extends) || (function () {
     var extendStatics = function (d, b) {
         extendStatics = Object.setPrototypeOf ||
             ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
@@ -4732,7 +4732,7 @@ connectionHolder$1.ConnectionHolder = ConnectionHolder;
  * releasing or initilizing
  */
 var ReadOnlyConnectionHolder = /** @class */ (function (_super) {
-    __extends$J(ReadOnlyConnectionHolder, _super);
+    __extends$K(ReadOnlyConnectionHolder, _super);
     /**
      * Contructor
      * @param {ConnectionHolder} connectionHolder the connection holder which will treat the requests
@@ -4786,7 +4786,7 @@ var ReadOnlyConnectionHolder = /** @class */ (function (_super) {
 connectionHolder$1.ReadOnlyConnectionHolder = ReadOnlyConnectionHolder;
 connectionHolder$1.default = ReadOnlyConnectionHolder;
 var EmptyConnectionHolder = /** @class */ (function (_super) {
-    __extends$J(EmptyConnectionHolder, _super);
+    __extends$K(EmptyConnectionHolder, _super);
     function EmptyConnectionHolder() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
@@ -5178,7 +5178,7 @@ function _valueOrDefault(value, defaultValue) {
 
 var logger$1 = {};
 
-var __extends$I = (commonjsGlobal && commonjsGlobal.__extends) || (function () {
+var __extends$J = (commonjsGlobal && commonjsGlobal.__extends) || (function () {
     var extendStatics = function (d, b) {
         extendStatics = Object.setPrototypeOf ||
             ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
@@ -5328,7 +5328,7 @@ var Logger$2 = /** @class */ (function () {
 }());
 logger$1.Logger = Logger$2;
 var NoOpLogger = /** @class */ (function (_super) {
-    __extends$I(NoOpLogger, _super);
+    __extends$J(NoOpLogger, _super);
     function NoOpLogger() {
         return _super.call(this, INFO, function (level, message) { }) || this;
     }
@@ -5926,8 +5926,12 @@ boltAgent$1.fromVersion = void 0;
 function fromVersion(version, getSystemInfo) {
     if (getSystemInfo === void 0) { getSystemInfo = function () { return ({
         get userAgent() {
+            // this should be defined as an `var` since we need to get information
+            // came from the global scope which not always will be defined
+            // and we don't want to override the information
+            var navigator;
             // @ts-ignore: browser code so must be skipped by ts
-            return window.navigator.userAgent;
+            return navigator === null || navigator === void 0 ? void 0 : navigator.userAgent;
         }
     }); }; }
     var systemInfo = getSystemInfo();
@@ -7620,7 +7624,7 @@ var transactionPromise = {};
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var __extends$H = (commonjsGlobal && commonjsGlobal.__extends) || (function () {
+var __extends$I = (commonjsGlobal && commonjsGlobal.__extends) || (function () {
     var extendStatics = function (d, b) {
         extendStatics = Object.setPrototypeOf ||
             ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
@@ -7664,7 +7668,7 @@ var transaction_1 = __importDefault$P(transaction);
  * @access public
  */
 var TransactionPromise = /** @class */ (function (_super) {
-    __extends$H(TransactionPromise, _super);
+    __extends$I(TransactionPromise, _super);
     /**
      * @constructor
      * @param {object} args
@@ -10147,7 +10151,232 @@ var types$1 = {};
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+var __extends$H = (commonjsGlobal && commonjsGlobal.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
 Object.defineProperty(types$1, "__esModule", { value: true });
+types$1.InternalConfig = types$1.Config = void 0;
+/**
+ * The Neo4j Driver configuration.
+ *
+ * @interface
+ */
+var Config = /** @class */ (function () {
+    /**
+     * @constructor
+     * @private
+     */
+    function Config() {
+        /**
+         * Encryption level
+         *
+         * @type {'ENCRYPTION_ON'|'ENCRYPTION_OFF'|undefined}
+         */
+        this.encrypted = undefined;
+        /**
+         * Trust strategy to use if encryption is enabled.
+         *
+         * There is no mode to disable trust other than disabling encryption altogether. The reason for
+         * this is that if you don't know who you are talking to, it is easy for an
+         * attacker to hijack your encrypted connection, rendering encryption pointless.
+         *
+         * TRUST_SYSTEM_CA_SIGNED_CERTIFICATES is the default choice. For NodeJS environments, this
+         * means that you trust whatever certificates are in the default trusted certificate
+         * store of the underlying system. For Browser environments, the trusted certificate
+         * store is usually managed by the browser. Refer to your system or browser documentation
+         * if you want to explicitly add a certificate as trusted.
+         *
+         * TRUST_CUSTOM_CA_SIGNED_CERTIFICATES is another option for trust verification -
+         * whenever we establish an encrypted connection, we ensure the host is using
+         * an encryption certificate that is in, or is signed by, a certificate given
+         * as trusted through configuration. This option is only available for NodeJS environments.
+         *
+         * TRUST_ALL_CERTIFICATES means that you trust everything without any verifications
+         * steps carried out.  This option is only available for NodeJS environments and should not
+         * be used on production systems.
+         *
+         * @type {'TRUST_SYSTEM_CA_SIGNED_CERTIFICATES'|'TRUST_CUSTOM_CA_SIGNED_CERTIFICATES'|'TRUST_ALL_CERTIFICATES'|undefined}
+         */
+        this.trust = undefined;
+        /**
+         * List of one or more paths to trusted encryption certificates.
+         *
+         * This only works in the NodeJS bundle,
+         * and only matters if you use "TRUST_CUSTOM_CA_SIGNED_CERTIFICATES".
+         *
+         * The certificate files should be in regular X.509 PEM format.
+         *
+         * For instance, ['./trusted.pem']
+         *
+         * @type {?string[]}
+         * @see {@link Config#trust}
+         */
+        this.trustedCertificates = [];
+        /**
+         * The maximum total number of connections allowed to be managed by the connection pool, per host.
+         *
+         * This includes both in-use and idle connections.
+         *
+         * **Default**: ```100```
+         *
+         * @type {number|undefined}
+         */
+        this.maxConnectionPoolSize = 100;
+        /**
+         * The maximum allowed lifetime for a pooled connection in milliseconds.
+         *
+         * Pooled connections older than this
+         * threshold will be closed and removed from the pool. Such discarding happens during connection acquisition
+         * so that new session is never backed by an old connection. Setting this option to a low value will cause
+         * a high connection churn and might result in a performance hit. It is recommended to set maximum lifetime
+         * to a slightly smaller value than the one configured in network equipment (load balancer, proxy, firewall,
+         * etc. can also limit maximum connection lifetime). No maximum lifetime limit is imposed by default. Zero
+         * and negative values result in lifetime not being checked.
+         *
+         * **Default**: ```60 * 60 * 1000``` (1 hour)
+         *
+         * @type {number|undefined}
+         */
+        this.maxConnectionLifetime = 60 * 60 * 1000; // 1 hour
+        /**
+         * The maximum amount of time to wait to acquire a connection from the pool (to either create a new
+         * connection or borrow an existing one).
+         *
+         * **Default**: ```60000``` (1 minute)
+         *
+         * @type {number|undefined}
+         */
+        this.connectionAcquisitionTimeout = 60000; // 1 minute
+        /**
+         * Specify the maximum time in milliseconds transactions are allowed to retry via
+         * {@link Session#executeRead} and {@link Session#executeWrite} functions.
+         *
+         * These functions will retry the given unit of work on `ServiceUnavailable`, `SessionExpired` and transient
+         * errors with exponential backoff using an initial delay of 1 second.
+         *
+         * **Default**: ```30000``` (30 seconds)
+         *
+         * @type {number|undefined}
+         */
+        this.maxTransactionRetryTime = 30000; // 30 seconds
+        /**
+         * Specify socket connection timeout in milliseconds.
+         *
+         * Negative and zero values result in no timeout being applied.
+         * Connection establishment will be then bound by the timeout configured
+         * on the operating system level.
+         *
+         * **Default**: ```30000``` (30 seconds)
+         *
+         * @type {number|undefined}
+         */
+        this.connectionTimeout = 30000; // 30 seconds
+        /**
+         * Make this driver always return native JavaScript numbers for integer values, instead of the
+         * dedicated {@link Integer} class.
+         *
+         * Values that do not fit in native number bit range will be represented as `Number.NEGATIVE_INFINITY` or `Number.POSITIVE_INFINITY`.
+         *
+         * **Warning:** {@link ResultSummary} It is not always safe to enable this setting when JavaScript applications are not the only ones
+         * interacting with the database. Stored numbers might in such case be not representable by native
+         * `Number` type and thus the driver will return lossy values. This might also happen when data was
+         * initially imported using neo4j import tool and contained numbers larger than
+         * `Number.MAX_SAFE_INTEGER`. Driver will then return positive infinity, which is lossy.
+         *
+         * **Default**: ```false```
+         *
+         * Default value for this option is `false` because native JavaScript numbers might result
+         * in loss of precision in the general case.
+         *
+         * @type {boolean|undefined}
+         */
+        this.disableLosslessIntegers = false;
+        /**
+         * Make this driver always return native Javascript `BigInt` for integer values,
+         * instead of the dedicated {@link Integer} class or `Number`.
+         *
+         * **Warning:** `BigInt` doesn't implement the method `toJSON`. To serialize it as `json`,
+         * it's needed to add a custom implementation of the `toJSON` on the
+         * `BigInt.prototype`. See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt#use_within_json.
+         *
+         * **Default**: ```false``` (for backwards compatibility)
+         *
+         * @type {boolean|undefined}
+         */
+        this.useBigInt = false;
+        /**
+         * Specify the logging configuration for the driver. Object should have two properties `level` and `logger`.
+         *
+         * Property `level` represents the logging level which should be one of: 'error', 'warn', 'info' or 'debug'. This property is optional and
+         * its default value is 'info'. Levels have priorities: 'error': 0, 'warn': 1, 'info': 2, 'debug': 3. Enabling a certain level also enables all
+         * levels with lower priority. For example: 'error', 'warn' and 'info' will be logged when 'info' level is configured.
+         *
+         * Property `logger` represents the logging function which will be invoked for every log call with an acceptable level. The function should
+         * take two string arguments `level` and `message`. The function should not execute any blocking or long-running operations
+         * because it is often executed on a hot path.
+         *
+         * No logging is done by default. See `neo4j.logging` object that contains predefined logging implementations.
+         *
+         * @type {LoggingConfig|undefined}
+         * @see {@link logging}
+         */
+        this.logging = undefined;
+        /**
+         * Specify a custom server address resolver function used by the routing driver to resolve the initial address used to create the driver.
+         *
+         * Such resolution happens:
+         *   * during the very first rediscovery when driver is created
+         *   * when all the known routers from the current routing table have failed and driver needs to fallback to the initial address
+         *
+         *  In NodeJS environment driver defaults to performing a DNS resolution of the initial address using 'dns' module.
+         *  In browser environment driver uses the initial address as-is.
+         *  Value should be a function that takes a single string argument - the initial address. It should return an array of new addresses.
+         *  Address is a string of shape '<host>:<port>'. Provided function can return either a Promise resolved with an array of addresses
+         *  or array of addresses directly.
+         *
+         * @type {function(address: string) {} |undefined}
+         */
+        this.resolver = undefined;
+        /**
+         * Configure filter for Notification objects returned in {@Link ResultSummary#notifications}.
+         *
+         * See {@link SessionConfig#notificationFilter} for usage instructions.
+         *
+         * @type {NotificationFilter|undefined}
+         */
+        this.notificationFilter = undefined;
+        /**
+         * Optionally override the default user agent name.
+         *
+         * **Default**: ```'neo4j-javascript/<version>'```
+         *
+         * @type {string|undefined}
+         */
+        this.userAgent = undefined;
+    }
+    return Config;
+}());
+types$1.Config = Config;
+var InternalConfig = /** @class */ (function (_super) {
+    __extends$H(InternalConfig, _super);
+    function InternalConfig() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return InternalConfig;
+}(Config));
+types$1.InternalConfig = InternalConfig;
 
 (function (exports) {
 /**
@@ -19387,7 +19616,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.9.0';
+version$1.default = '5.9.1';
 
 var lib = {};
 
@@ -30786,7 +31015,7 @@ var Connection = /** @class */ (function () {
     /**
      * Connect to the target address, negotiate Bolt protocol and send initialization message.
      * @param {string} userAgent the user agent for this driver.
-     * @param {string} boltAgent the bolt agent for this driver.
+     * @param {Object} boltAgent the bolt agent for this driver.
      * @param {Object} authToken the object containing auth information.
      * @param {boolean} shouldWaitReAuth whether ot not the connection will wait for re-authentication to happen
      * @return {Promise<Connection>} promise resolved with the current connection if connection is successful. Rejected promise otherwise.
@@ -31054,7 +31283,7 @@ var ChannelConnection = /** @class */ (function (_super) {
     /**
      * Send initialization message.
      * @param {string} userAgent the user agent for this driver.
-     * @param {string} boltAgent the bolt agent for this driver.
+     * @param {Object} boltAgent the bolt agent for this driver.
      * @param {Object} authToken the object containing auth information.
      * @param {boolean} waitReAuth whether ot not the connection will wait for re-authentication to happen
      * @return {Promise<Connection>} promise resolved with the current connection if connection is successful. Rejected promise otherwise.
@@ -33841,141 +34070,16 @@ function createAuthManager(authTokenOrManager) {
  * Construct a new Neo4j Driver. This is your main entry point for this
  * library.
  *
- * ## Configuration
- *
- * This function optionally takes a configuration argument. Available configuration
- * options are as follows:
- *
- *     {
- *       // Encryption level: ENCRYPTION_ON or ENCRYPTION_OFF.
- *       encrypted: ENCRYPTION_ON|ENCRYPTION_OFF
- *
- *       // Trust strategy to use if encryption is enabled. There is no mode to disable
- *       // trust other than disabling encryption altogether. The reason for
- *       // this is that if you don't know who you are talking to, it is easy for an
- *       // attacker to hijack your encrypted connection, rendering encryption pointless.
- *       //
- *       // TRUST_SYSTEM_CA_SIGNED_CERTIFICATES is the default choice. For NodeJS environments, this
- *       // means that you trust whatever certificates are in the default trusted certificate
- *       // store of the underlying system. For Browser environments, the trusted certificate
- *       // store is usually managed by the browser. Refer to your system or browser documentation
- *       // if you want to explicitly add a certificate as trusted.
- *       //
- *       // TRUST_CUSTOM_CA_SIGNED_CERTIFICATES is another option for trust verification -
- *       // whenever we establish an encrypted connection, we ensure the host is using
- *       // an encryption certificate that is in, or is signed by, a certificate given
- *       // as trusted through configuration. This option is only available for NodeJS environments.
- *       //
- *       // TRUST_ALL_CERTIFICATES means that you trust everything without any verifications
- *       // steps carried out.  This option is only available for NodeJS environments and should not
- *       // be used on production systems.
- *       trust: "TRUST_SYSTEM_CA_SIGNED_CERTIFICATES" | "TRUST_CUSTOM_CA_SIGNED_CERTIFICATES" |
- *       "TRUST_ALL_CERTIFICATES",
- *
- *       // List of one or more paths to trusted encryption certificates. This only
- *       // works in the NodeJS bundle, and only matters if you use "TRUST_CUSTOM_CA_SIGNED_CERTIFICATES".
- *       // The certificate files should be in regular X.509 PEM format.
- *       // For instance, ['./trusted.pem']
- *       trustedCertificates: [],
- *
- *       // The maximum total number of connections allowed to be managed by the connection pool, per host.
- *       // This includes both in-use and idle connections. No maximum connection pool size is imposed
- *       // by default.
- *       maxConnectionPoolSize: 100,
- *
- *       // The maximum allowed lifetime for a pooled connection in milliseconds. Pooled connections older than this
- *       // threshold will be closed and removed from the pool. Such discarding happens during connection acquisition
- *       // so that new session is never backed by an old connection. Setting this option to a low value will cause
- *       // a high connection churn and might result in a performance hit. It is recommended to set maximum lifetime
- *       // to a slightly smaller value than the one configured in network equipment (load balancer, proxy, firewall,
- *       // etc. can also limit maximum connection lifetime). No maximum lifetime limit is imposed by default. Zero
- *       // and negative values result in lifetime not being checked.
- *       maxConnectionLifetime: 60 * 60 * 1000, // 1 hour
- *
- *       // The maximum amount of time to wait to acquire a connection from the pool (to either create a new
- *       // connection or borrow an existing one.
- *       connectionAcquisitionTimeout: 60000, // 1 minute
- *
- *       // Specify the maximum time in milliseconds transactions are allowed to retry via
- *       // `Session#executeRead()` and `Session#executeWrite()` functions.
- *       // These functions will retry the given unit of work on `ServiceUnavailable`, `SessionExpired` and transient
- *       // errors with exponential backoff using initial delay of 1 second.
- *       // Default value is 30000 which is 30 seconds.
- *       maxTransactionRetryTime: 30000, // 30 seconds
- *
- *       // Specify socket connection timeout in milliseconds. Numeric values are expected. Negative and zero values
- *       // result in no timeout being applied. Connection establishment will be then bound by the timeout configured
- *       // on the operating system level. Default value is 30000, which is 30 seconds.
- *       connectionTimeout: 30000, // 30 seconds
- *
- *       // Make this driver always return native JavaScript numbers for integer values, instead of the
- *       // dedicated {@link Integer} class. Values that do not fit in native number bit range will be represented as
- *       // `Number.NEGATIVE_INFINITY` or `Number.POSITIVE_INFINITY`.
- *       // **Warning:** ResultSummary It is not always safe to enable this setting when JavaScript applications are not the only ones
- *       // interacting with the database. Stored numbers might in such case be not representable by native
- *       // {@link Number} type and thus driver will return lossy values. This might also happen when data was
- *       // initially imported using neo4j import tool and contained numbers larger than
- *       // `Number.MAX_SAFE_INTEGER`. Driver will then return positive infinity, which is lossy.
- *       // Default value for this option is `false` because native JavaScript numbers might result
- *       // in loss of precision in the general case.
- *       disableLosslessIntegers: false,
- *
- *       // Make this driver always return native Javascript {@link BigInt} for integer values, instead of the dedicated {@link Integer} class or {@link Number}.
- *       //
- *       // Default value for this option is `false` for backwards compatibility.
- *       //
- *       // **Warning:** `BigInt` doesn't implement the method `toJSON`. In maner of serialize it as `json`, It's needed to add a custom implementation of the `toJSON` on the
- *       // `BigInt.prototype` {@see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt#use_within_json}
- *       useBigInt: false,
- *
- *       // Specify the logging configuration for the driver. Object should have two properties `level` and `logger`.
- *       //
- *       // Property `level` represents the logging level which should be one of: 'error', 'warn', 'info' or 'debug'. This property is optional and
- *       // its default value is 'info'. Levels have priorities: 'error': 0, 'warn': 1, 'info': 2, 'debug': 3. Enabling a certain level also enables all
- *       // levels with lower priority. For example: 'error', 'warn' and 'info' will be logged when 'info' level is configured.
- *       //
- *       // Property `logger` represents the logging function which will be invoked for every log call with an acceptable level. The function should
- *       // take two string arguments `level` and `message`. The function should not execute any blocking or long-running operations
- *       // because it is often executed on a hot path.
- *       //
- *       // No logging is done by default. See `neo4j.logging` object that contains predefined logging implementations.
- *       logging: {
- *         level: 'info',
- *         logger: (level, message) => console.log(level + ' ' + message)
- *       },
- *
- *       // Specify a custom server address resolver function used by the routing driver to resolve the initial address used to create the driver.
- *       // Such resolution happens:
- *       //  * during the very first rediscovery when driver is created
- *       //  * when all the known routers from the current routing table have failed and driver needs to fallback to the initial address
- *       //
- *       // In NodeJS environment driver defaults to performing a DNS resolution of the initial address using 'dns' module.
- *       // In browser environment driver uses the initial address as-is.
- *       // Value should be a function that takes a single string argument - the initial address. It should return an array of new addresses.
- *       // Address is a string of shape '<host>:<port>'. Provided function can return either a Promise resolved with an array of addresses
- *       // or array of addresses directly.
- *       resolver: function(address) {
- *         return ['127.0.0.1:8888', 'fallback.db.com:7687'];
- *       },
- *
- *       // Configure filter for Notification objects returned in ResultSummary#notifications.
- *       // See SessionConfig#notificationFilter for usage instructions.
- *       notificationFilter: undefined,
- *
- *       // Optionally override the default user agent name.
- *       userAgent: USER_AGENT
- *     }
- *
  * @param {string} url The URL for the Neo4j database, for instance "neo4j://localhost" and/or "bolt://localhost"
  * @param {Map<string,string>} authToken Authentication credentials. See {@link auth} for helpers.
- * @param {Object} config Configuration object. See the configuration section above for details.
+ * @param {Config} config Configuration object.
  * @returns {Driver}
  */
 function driver(url, authToken, config) {
     if (config === void 0) { config = {}; }
     assertString(url, 'Bolt URL');
     var parsedUrl = urlUtil.parseDatabaseUrl(url);
-    // Determine entryption/trust options from the URL.
+    // Determine encryption/trust options from the URL.
     var routing = false;
     var encrypted = false;
     var trust;