Verifying types exported by the lite version

Author: bigmontz

core/src/driver.ts

@@ -33,7 +33,12 @@ import { Logger } from './internal/logger'
 import Session from './session'
 import { ServerInfo } from './result-summary'
 import { ENCRYPTION_ON, ENCRYPTION_OFF } from './internal/util'
-import { EncryptionLevel, LoggingConfig, TrustStrategy } from './types'
+import {
+  EncryptionLevel,
+  LoggingConfig,
+  TrustStrategy,
+  SessionMode
+} from './types'
 import { ServerAddress } from './internal/server-address'
 
 const DEFAULT_MAX_CONNECTION_LIFETIME: number = 60 * 60 * 1000 // 1 hour
@@ -49,14 +54,14 @@ const DEFAULT_FETCH_SIZE: number = 1000
  * Should be used like this: `driver.session({ defaultAccessMode: neo4j.session.READ })`.
  * @type {string}
  */
-const READ: string = ACCESS_MODE_READ
+const READ: SessionMode = ACCESS_MODE_READ
 
 /**
  * Constant that represents write session access mode.
  * Should be used like this: `driver.session({ defaultAccessMode: neo4j.session.WRITE })`.
  * @type {string}
  */
-const WRITE: string = ACCESS_MODE_WRITE
+const WRITE: SessionMode = ACCESS_MODE_WRITE
 
 let idGenerator = 0
 
@@ -227,7 +232,7 @@ class Driver {
     database = '',
     fetchSize
   }: {
-    defaultAccessMode?: string
+    defaultAccessMode?: SessionMode
     bookmarks?: string | string[]
     database?: string
     fetchSize?: number
@@ -274,7 +279,7 @@ class Driver {
     reactive,
     fetchSize
   }: {
-    defaultAccessMode: string
+    defaultAccessMode: SessionMode
     bookmarkOrBookmarks?: string | string[]
     database: string
     reactive: boolean

core/src/index.ts

@@ -67,6 +67,7 @@ import ResultSummary, {
 } from './result-summary'
 import Result, { QueryResult, ResultObserver } from './result'
 import ConnectionProvider from './connection-provider'
+import Connection from './connection'
 import Transaction from './transaction'
 import Session, { TransactionConfig } from './session'
 import Driver, * as driver from './driver'
@@ -133,6 +134,7 @@ const forExport = {
   Transaction,
   Session,
   Driver,
+  Connection,
   types,
   driver
 }
@@ -188,6 +190,7 @@ export {
   QueryResult,
   ResultObserver,
   ConnectionProvider,
+  Connection,
   Transaction,
   Session,
   TransactionConfig,

core/src/internal/constants.ts

@@ -21,8 +21,8 @@ const FETCH_ALL = -1
 const DEFAULT_POOL_ACQUISITION_TIMEOUT = 60 * 1000 // 60 seconds
 const DEFAULT_POOL_MAX_SIZE = 100
 
-const ACCESS_MODE_READ: string = 'READ'
-const ACCESS_MODE_WRITE: string = 'WRITE'
+const ACCESS_MODE_READ: 'READ' = 'READ'
+const ACCESS_MODE_WRITE: 'WRITE' = 'WRITE'
 
 const BOLT_PROTOCOL_V1: number = 1
 const BOLT_PROTOCOL_V2: number = 2

core/src/session.ts

@@ -27,7 +27,7 @@ import { TransactionExecutor } from './internal/transaction-executor'
 import { Bookmark } from './internal/bookmark'
 import { TxConfig } from './internal/tx-config'
 import ConnectionProvider from './connection-provider'
-import { Query } from './types'
+import { Query, SessionMode } from './types'
 import Connection from './connection'
 import { NumberOrInteger } from './graph-types'
 
@@ -47,7 +47,7 @@ interface TransactionConfig {
  * @access public
  */
 class Session {
-  private _mode: string
+  private _mode: SessionMode
   private _database: string
   private _reactive: boolean
   private _fetchSize: number
@@ -80,9 +80,9 @@ class Session {
     reactive,
     fetchSize
   }: {
-    mode: string
+    mode: SessionMode
     connectionProvider: ConnectionProvider
-    bookmark: Bookmark
+    bookmark?: Bookmark
     database: string
     config: any
     reactive: boolean
@@ -106,7 +106,7 @@ class Session {
     })
     this._open = true
     this._hasTx = false
-    this._lastBookmark = bookmark
+    this._lastBookmark = bookmark || Bookmark.empty()
     this._transactionExecutor = _createTransactionExecutor(config)
     this._onComplete = this._onCompleteCallback.bind(this)
   }
@@ -233,7 +233,7 @@ class Session {
     return this._beginTransaction(this._mode, txConfig)
   }
 
-  _beginTransaction(accessMode: string, txConfig: TxConfig): Transaction {
+  _beginTransaction(accessMode: SessionMode, txConfig: TxConfig): Transaction {
     if (!this._open) {
       throw newError('Cannot begin a transaction on a closed session.')
     }
@@ -333,7 +333,7 @@ class Session {
   }
 
   _runTransaction<T>(
-    accessMode: string,
+    accessMode: SessionMode,
     transactionConfig: TxConfig,
     transactionWork: TransactionWork<T>
   ): Promise<T> {
@@ -369,7 +369,7 @@ class Session {
     }
   }
 
-  _connectionHolderWithMode(mode: string): ConnectionHolder {
+  _connectionHolderWithMode(mode: SessionMode): ConnectionHolder {
     if (mode === ACCESS_MODE_READ) {
       return this._readConnectionHolder
     } else if (mode === ACCESS_MODE_WRITE) {
@@ -391,7 +391,7 @@ class Session {
   /**
    * @protected
    */
-  static _validateSessionMode(rawMode?: string): string {
+  static _validateSessionMode(rawMode?: SessionMode): SessionMode {
     const mode = rawMode || ACCESS_MODE_WRITE
     if (mode !== ACCESS_MODE_READ && mode !== ACCESS_MODE_WRITE) {
       throw newError('Illegal session mode ' + mode)

core/src/types.ts

@@ -28,6 +28,8 @@ export type LogLevel = 'error' | 'warn' | 'info' | 'debug'
 
 export type LoggerFunction = (level: LogLevel, message: string) => unknown
 
+export type SessionMode = 'READ' | 'WRITE'
+
 export interface LoggingConfig {
   level?: LogLevel
   logger: LoggerFunction

neo4j-driver-lite/src/index.ts

@@ -53,6 +53,16 @@ import {
   ConnectionProvider,
   Driver,
   QueryResult,
+  ResultObserver,
+  Plan,
+  ProfiledPlan,
+  QueryStatistics,
+  Notification,
+  NotificationPosition,
+  Session,
+  Transaction,
+  ServerInfo,
+  Connection,
   driver as coreDriver,
   types as coreTypes
 } from 'neo4j-driver-core'
@@ -64,6 +74,8 @@ import {
 type AuthToken = coreTypes.AuthToken
 type Config = coreTypes.Config
 type TrustStrategy = coreTypes.TrustStrategy
+type EncryptionLevel = coreTypes.EncryptionLevel
+type SessionMode = coreTypes.SessionMode
 type Logger = internal.logger.Logger
 type ConfiguredCustomResolver = internal.resolver.ConfiguredCustomResolver
 type LogLevel = coreTypes.LogLevel
@@ -456,7 +468,31 @@ const forExport = {
   spatial,
   temporal,
   Driver,
-  Result
+  Result,
+  Record,
+  ResultSummary,
+  Node,
+  Relationship,
+  UnboundRelationship,
+  PathSegment,
+  Path,
+  Integer,
+  Plan,
+  ProfiledPlan,
+  QueryStatistics,
+  Notification,
+  ServerInfo,
+  Session,
+  Transaction,
+  Point,
+  Duration,
+  LocalTime,
+  Time,
+  Date,
+  LocalDateTime,
+  DateTime,
+  ConnectionProvider,
+  Connection
 }
 
 export {
@@ -481,6 +517,37 @@ export {
   temporal,
   Driver,
   Result,
-  QueryResult
+  QueryResult,
+  Record,
+  ResultSummary,
+  AuthToken,
+  Config,
+  EncryptionLevel,
+  TrustStrategy,
+  SessionMode,
+  Node,
+  Relationship,
+  UnboundRelationship,
+  PathSegment,
+  Path,
+  Integer,
+  ResultObserver,
+  Plan,
+  ProfiledPlan,
+  QueryStatistics,
+  Notification,
+  NotificationPosition,
+  ServerInfo,
+  Session,
+  Transaction,
+  Point,
+  Duration,
+  LocalTime,
+  Time,
+  Date,
+  LocalDateTime,
+  DateTime,
+  ConnectionProvider,
+  Connection
 }
 export default forExport