neo4j-driver 5.6.0 → 5.8.0

package/lib/docs.js

@@ -30,7 +30,8 @@
  * @property {number} timeout - the transaction timeout in **milliseconds**. Transactions that execute longer than the configured timeout will
  * be terminated by the database. This functionality allows to limit query/transaction execution time. Specified timeout overrides the default timeout
  * configured in the database using `dbms.transaction.timeout` setting. Value should not represent a duration of zero or negative duration.
- * @property {Object} metadata - the transaction metadata. Specified metadata will be attached to the executing transaction and visible in the output of
- * `dbms.listQueries` and `dbms.listTransactions` procedures. It will also get logged to the `query.log`. This functionality makes it easier to tag
- * transactions and is equivalent to `dbms.setTXMetaData` procedure.
+ * @property {Object} metadata - the transaction metadata. Specified metadata will be attached to the executing transaction and visible in the output
+ * of `SHOW TRANSACTIONS YIELD *`. It will also get logged to the `query.log` file. This functionality makes it easier to tag transactions and is
+ * equivalent to the `dbms.setTXMetaData` procedure, see https://neo4j.com/docs/cypher-manual/current/clauses/transaction-clauses/#query-listing-transactions
+ * and https://neo4j.com/docs/operations-manual/current/reference/procedures/ for reference.
  */

package/lib/driver.js

@@ -74,16 +74,18 @@ var Driver = /** @class */ (function (_super) {
      * @returns {RxSession} new reactive session.
      */
     Driver.prototype.rxSession = function (_a) {
-        var _b = _a === void 0 ? {} : _a, _c = _b.defaultAccessMode, defaultAccessMode = _c === void 0 ? WRITE : _c, bookmarks = _b.bookmarks, _d = _b.database, database = _d === void 0 ? '' : _d, fetchSize = _b.fetchSize, impersonatedUser = _b.impersonatedUser, bookmarkManager = _b.bookmarkManager;
+        var _b = _a === void 0 ? {} : _a, _c = _b.defaultAccessMode, defaultAccessMode = _c === void 0 ? WRITE : _c, bookmarks = _b.bookmarks, _d = _b.database, database = _d === void 0 ? '' : _d, fetchSize = _b.fetchSize, impersonatedUser = _b.impersonatedUser, bookmarkManager = _b.bookmarkManager, notificationFilter = _b.notificationFilter, auth = _b.auth;
         return new session_rx_1.default({
             session: this._newSession({
                 defaultAccessMode: defaultAccessMode,
                 bookmarkOrBookmarks: bookmarks,
                 database: database,
                 impersonatedUser: impersonatedUser,
+                auth: auth,
                 reactive: false,
                 fetchSize: validateFetchSizeValue(fetchSize, this._config.fetchSize),
-                bookmarkManager: bookmarkManager
+                bookmarkManager: bookmarkManager,
+                notificationFilter: notificationFilter
             }),
             config: this._config
         });

package/lib/index.js

@@ -40,7 +40,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PathSegment = exports.Path = exports.UnboundRelationship = exports.Relationship = exports.Node = exports.Record = exports.ServerInfo = exports.Notification = exports.QueryStatistics = exports.ProfiledPlan = exports.Plan = exports.ResultSummary = exports.RxResult = exports.RxManagedTransaction = exports.RxTransaction = exports.RxSession = exports.EagerResult = exports.Result = exports.ManagedTransaction = exports.Transaction = exports.Session = exports.Driver = exports.temporal = exports.spatial = exports.graph = exports.error = exports.routing = exports.session = exports.types = exports.logging = exports.auth = exports.isRetryableError = exports.Neo4jError = exports.integer = exports.isUnboundRelationship = exports.isRelationship = exports.isPathSegment = exports.isPath = exports.isNode = exports.isDateTime = exports.isLocalDateTime = exports.isDate = exports.isTime = exports.isLocalTime = exports.isDuration = exports.isPoint = exports.isInt = exports.int = exports.hasReachableServer = exports.driver = void 0;
-exports.resultTransformers = exports.bookmarkManager = exports.DateTime = exports.LocalDateTime = exports.Date = exports.Time = exports.LocalTime = exports.Duration = exports.Integer = exports.Point = void 0;
+exports.expirationBasedAuthTokenManager = exports.notificationFilterMinimumSeverityLevel = exports.notificationFilterDisabledCategory = exports.notificationSeverityLevel = exports.notificationCategory = exports.resultTransformers = exports.bookmarkManager = exports.DateTime = exports.LocalDateTime = exports.Date = exports.Time = exports.LocalTime = exports.Duration = exports.Integer = exports.Point = void 0;
 /**
  * Copyright (c) "Neo4j"
  * Neo4j Sweden AB [http://neo4j.com]
@@ -109,6 +109,11 @@ Object.defineProperty(exports, "ManagedTransaction", { enumerable: true, get: fu
 Object.defineProperty(exports, "bookmarkManager", { enumerable: true, get: function () { return neo4j_driver_core_1.bookmarkManager; } });
 Object.defineProperty(exports, "routing", { enumerable: true, get: function () { return neo4j_driver_core_1.routing; } });
 Object.defineProperty(exports, "resultTransformers", { enumerable: true, get: function () { return neo4j_driver_core_1.resultTransformers; } });
+Object.defineProperty(exports, "notificationCategory", { enumerable: true, get: function () { return neo4j_driver_core_1.notificationCategory; } });
+Object.defineProperty(exports, "notificationSeverityLevel", { enumerable: true, get: function () { return neo4j_driver_core_1.notificationSeverityLevel; } });
+Object.defineProperty(exports, "notificationFilterDisabledCategory", { enumerable: true, get: function () { return neo4j_driver_core_1.notificationFilterDisabledCategory; } });
+Object.defineProperty(exports, "notificationFilterMinimumSeverityLevel", { enumerable: true, get: function () { return neo4j_driver_core_1.notificationFilterMinimumSeverityLevel; } });
+Object.defineProperty(exports, "expirationBasedAuthTokenManager", { enumerable: true, get: function () { return neo4j_driver_core_1.expirationBasedAuthTokenManager; } });
 var neo4j_driver_bolt_connection_1 = require("neo4j-driver-bolt-connection");
 var session_rx_1 = __importDefault(require("./session-rx"));
 exports.RxSession = session_rx_1.default;
@@ -119,6 +124,24 @@ exports.RxManagedTransaction = transaction_managed_rx_1.default;
 var result_rx_1 = __importDefault(require("./result-rx"));
 exports.RxResult = result_rx_1.default;
 var _a = neo4j_driver_core_1.internal.util, ENCRYPTION_ON = _a.ENCRYPTION_ON, assertString = _a.assertString, isEmptyObjectOrNull = _a.isEmptyObjectOrNull, ServerAddress = neo4j_driver_core_1.internal.serverAddress.ServerAddress, urlUtil = neo4j_driver_core_1.internal.urlUtil;
+function isAuthTokenManager(value) {
+    return typeof value === 'object' &&
+        value != null &&
+        'getToken' in value &&
+        'onTokenExpired' in value &&
+        typeof value.getToken === 'function' &&
+        typeof value.onTokenExpired === 'function';
+}
+function createAuthManager(authTokenOrManager) {
+    if (isAuthTokenManager(authTokenOrManager)) {
+        return authTokenOrManager;
+    }
+    var authToken = authTokenOrManager;
+    // Sanitize authority token. Nicer error from server when a scheme is set.
+    authToken = authToken || {};
+    authToken.scheme = authToken.scheme || 'none';
+    return (0, neo4j_driver_core_1.staticAuthTokenManager)({ authToken: authToken });
+}
 /**
  * Construct a new Neo4j Driver. This is your main entry point for this
  * library.
@@ -240,7 +263,11 @@ var _a = neo4j_driver_core_1.internal.util, ENCRYPTION_ON = _a.ENCRYPTION_ON, as
  *         return ['127.0.0.1:8888', 'fallback.db.com:7687'];
  *       },
  *
- *      // Optionally override the default user agent name.
+ *       // 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
  *     }
  *
@@ -293,9 +320,7 @@ function driver(url, authToken, config) {
         config.encrypted = ENCRYPTION_ON;
         config.trust = trust;
     }
-    // Sanitize authority token. Nicer error from server when a scheme is set.
-    authToken = authToken || {};
-    authToken.scheme = authToken.scheme || 'none';
+    var authTokenManager = createAuthManager(authToken);
     // Use default user agent or user agent specified by user.
     config.userAgent = config.userAgent || USER_AGENT;
     var address = ServerAddress.fromUrl(parsedUrl.hostAndPort);
@@ -313,7 +338,7 @@ function driver(url, authToken, config) {
                     config: config,
                     log: log,
                     hostNameResolver: hostNameResolver,
-                    authToken: authToken,
+                    authTokenManager: authTokenManager,
                     address: address,
                     userAgent: config.userAgent,
                     routingContext: parsedUrl.query
@@ -329,7 +354,7 @@ function driver(url, authToken, config) {
                     id: id,
                     config: config,
                     log: log,
-                    authToken: authToken,
+                    authTokenManager: authTokenManager,
                     address: address,
                     userAgent: config.userAgent
                 });
@@ -522,6 +547,11 @@ var forExport = {
     LocalDateTime: neo4j_driver_core_1.LocalDateTime,
     DateTime: neo4j_driver_core_1.DateTime,
     bookmarkManager: neo4j_driver_core_1.bookmarkManager,
-    resultTransformers: neo4j_driver_core_1.resultTransformers
+    resultTransformers: neo4j_driver_core_1.resultTransformers,
+    notificationCategory: neo4j_driver_core_1.notificationCategory,
+    notificationSeverityLevel: neo4j_driver_core_1.notificationSeverityLevel,
+    notificationFilterDisabledCategory: neo4j_driver_core_1.notificationFilterDisabledCategory,
+    notificationFilterMinimumSeverityLevel: neo4j_driver_core_1.notificationFilterMinimumSeverityLevel,
+    expirationBasedAuthTokenManager: neo4j_driver_core_1.expirationBasedAuthTokenManager
 };
 exports.default = forExport;

package/lib/version.js

@@ -26,4 +26,4 @@ Object.defineProperty(exports, "__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.
-exports.default = '5.6.0';
+exports.default = '5.8.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "neo4j-driver",
-  "version": "5.6.0",
+  "version": "5.8.0",
   "description": "The official Neo4j driver for Javascript",
   "author": "Neo4j",
   "license": "Apache-2.0",
@@ -74,14 +74,14 @@
     "rollup-plugin-polyfill-node": "^0.11.0",
     "semver": "^7.3.8",
     "tmp": "0.2.1",
-    "typescript": "^4.9.4",
+    "typescript": "^4.9.5",
     "vinyl-buffer": "^1.0.1",
     "webpack": "^5.75.0"
   },
   "dependencies": {
-    "neo4j-driver-bolt-connection": "^5.6.0",
-    "neo4j-driver-core": "^5.6.0",
+    "neo4j-driver-bolt-connection": "^5.8.0",
+    "neo4j-driver-core": "^5.8.0",
     "rxjs": "^7.8.0"
   },
-  "gitHead": "d6a6cf797a071485dd95015f689f396837a007c5"
+  "gitHead": "d8c4e0f4f9643f99da56bb8f1d179d0ec4b3b3ab"
 }

package/types/index.d.ts

@@ -74,7 +74,19 @@ import {
   RoutingControl,
   routing,
   resultTransformers,
-  ResultTransformer
+  ResultTransformer,
+  notificationCategory,
+  notificationSeverityLevel,
+  NotificationCategory,
+  NotificationSeverityLevel,
+  NotificationFilter,
+  NotificationFilterDisabledCategory,
+  NotificationFilterMinimumSeverityLevel,
+  notificationFilterDisabledCategory,
+  notificationFilterMinimumSeverityLevel,
+  AuthTokenManager,
+  AuthTokenAndExpiration,
+  expirationBasedAuthTokenManager
 } from 'neo4j-driver-core'
 import {
   AuthToken,
@@ -252,6 +264,11 @@ declare const forExport: {
   isUnboundRelationship: typeof isUnboundRelationship
   bookmarkManager: typeof bookmarkManager
   resultTransformers: typeof resultTransformers
+  notificationCategory: typeof notificationCategory
+  notificationSeverityLevel: typeof notificationSeverityLevel
+  notificationFilterDisabledCategory: typeof notificationFilterDisabledCategory
+  notificationFilterMinimumSeverityLevel: typeof notificationFilterMinimumSeverityLevel
+  expirationBasedAuthTokenManager: typeof expirationBasedAuthTokenManager
 }
 
 export {
@@ -321,7 +338,12 @@ export {
   isRelationship,
   isUnboundRelationship,
   bookmarkManager,
-  resultTransformers
+  resultTransformers,
+  notificationCategory,
+  notificationSeverityLevel,
+  notificationFilterDisabledCategory,
+  notificationFilterMinimumSeverityLevel,
+  expirationBasedAuthTokenManager
 }
 
 export type {
@@ -330,7 +352,14 @@ export type {
   SessionConfig,
   QueryConfig,
   RoutingControl,
-  ResultTransformer
+  ResultTransformer,
+  NotificationCategory,
+  NotificationSeverityLevel,
+  NotificationFilter,
+  NotificationFilterDisabledCategory,
+  NotificationFilterMinimumSeverityLevel,
+  AuthTokenManager,
+  AuthTokenAndExpiration
 }
 
 export default forExport