Export logging types in neo4j-driver (#1115)

bigmontz · web-flow · commit abae16405f32 · 2023-07-21T10:33:33.000+02:00
The types was not exported causing issues when configure logs in typescript.
diff --git a/packages/neo4j-driver/test/types/export.test.ts b/packages/neo4j-driver/test/types/export.test.ts
@@ -62,6 +62,10 @@ const driverConfiguration0 = driver.driver('driver', undefined, {
 
 const driverConfiguration1 = driver.driver('driver', undefined, {})
 
+const driverConfiguration2 = driver.driver('driver', undefined, {
+  logging: driver.logging.console('debug')
+})
+
 const session = new Session({
   mode: 'READ',
   connectionProvider: new ConnectionProvider(),
diff --git a/packages/neo4j-driver/types/index.d.ts b/packages/neo4j-driver/types/index.d.ts
@@ -86,7 +86,8 @@ import {
   notificationFilterMinimumSeverityLevel,
   AuthTokenManager,
   AuthTokenAndExpiration,
-  expirationBasedAuthTokenManager
+  expirationBasedAuthTokenManager,
+  types as coreTypes
 } from 'neo4j-driver-core'
 import {
   AuthToken,
@@ -120,6 +121,18 @@ declare const auth: {
   ) => AuthToken
 }
 
+/**
+ * Object containing predefined logging configurations. These are expected to be used as values of the driver config's `logging` property.
+ * @property {function(level: ?string): object} console the function to create a logging config that prints all messages to `console.log` with
+ * timestamp, level and message. It takes an optional `level` parameter which represents the maximum log level to be logged. Default value is 'info'.
+ */
+declare const logging: {
+  console: (level: coreTypes.LogLevel) => {
+    level: coreTypes.LogLevel
+    logger: (level: coreTypes.LogLevel, message: string) => void
+  }
+}
+
 declare function driver (
   url: string,
   authToken?: AuthToken | AuthTokenManager,
@@ -269,6 +282,7 @@ declare const forExport: {
   notificationFilterDisabledCategory: typeof notificationFilterDisabledCategory
   notificationFilterMinimumSeverityLevel: typeof notificationFilterMinimumSeverityLevel
   expirationBasedAuthTokenManager: typeof expirationBasedAuthTokenManager
+  logging: typeof logging
 }
 
 export {
@@ -343,7 +357,8 @@ export {
   notificationSeverityLevel,
   notificationFilterDisabledCategory,
   notificationFilterMinimumSeverityLevel,
-  expirationBasedAuthTokenManager
+  expirationBasedAuthTokenManager,
+  logging
 }
 
 export type {
