neo4j-driver/types/index.d.ts

The official Neo4j driver for Javascript

/**
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://neo4j.com]
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import {
  authTokenManagers,
  AuthTokenManagers,
  Neo4jError,
  isRetriableError,
  error,
  Integer,
  inSafeRange,
  int,
  isInt,
  toNumber,
  toString,
  isPoint,
  Point,
  Date,
  DateTime,
  Duration,
  isDate,
  isDateTime,
  isDuration,
  isLocalDateTime,
  isLocalTime,
  isTime,
  isNode,
  isPath,
  isPathSegment,
  isRelationship,
  isUnboundRelationship,
  LocalDateTime,
  LocalTime,
  Time,
  Node,
  Path,
  PathSegment,
  Relationship,
  UnboundRelationship,
  Record,
  RecordShape,
  ResultSummary,
  Notification,
  GqlStatusObject,
  NotificationPosition,
  Plan,
  ProfiledPlan,
  ServerInfo,
  QueryStatistics,
  Result,
  EagerResult,
  ResultObserver,
  QueryResult,
  Transaction,
  ManagedTransaction,
  Session,
  BookmarkManager,
  bookmarkManager,
  BookmarkManagerConfig,
  SessionConfig,
  QueryConfig,
  RoutingControl,
  routing,
  resultTransformers,
  ResultTransformer,
  notificationCategory,
  notificationClassification,
  notificationSeverityLevel,
  NotificationCategory,
  NotificationClassification,
  NotificationSeverityLevel,
  NotificationFilter,
  NotificationFilterDisabledCategory,
  NotificationFilterDisabledClassification,
  NotificationFilterMinimumSeverityLevel,
  notificationFilterDisabledCategory,
  notificationFilterDisabledClassification,
  notificationFilterMinimumSeverityLevel,
  AuthTokenManager,
  AuthTokenAndExpiration,
  ClientCertificate,
  ClientCertificateProvider,
  ClientCertificateProviders,
  RotatingClientCertificateProvider,
  clientCertificateProviders,
  types as coreTypes
} from 'neo4j-driver-core'
import {
  AuthToken,
  Config,
  Driver,
  EncryptionLevel,
  READ,
  SessionMode,
  TrustStrategy,
  WRITE
} from './driver'
import RxSession from './session-rx'
import RxTransaction from './transaction-rx'
import RxManagedTransaction from './transaction-managed-rx'
import RxResult from './result-rx'
import { Parameters } from './query-runner'

declare const auth: {
  basic: (username: string, password: string, realm?: string) => AuthToken

  kerberos: (base64EncodedTicket: string) => AuthToken

  bearer: (base64EncodedToken: string) => AuthToken

  custom: (
    principal: string,
    credentials: string,
    realm: string,
    scheme: string,
    parameters?: Parameters
  ) => 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,
  config?: Config
): Driver

declare function hasReachableServer (
  url: string,
  config?: Pick<Config, 'logging'>
): Promise<true>

declare const types: {
  Node: typeof Node
  Relationship: typeof Relationship
  UnboundRelationship: typeof UnboundRelationship
  PathSegment: typeof PathSegment
  Path: typeof Path
  Result: typeof Result
  EagerResult: typeof EagerResult
  ResultSummary: typeof ResultSummary
  Record: typeof Record
  Point: typeof Point
  Duration: typeof Duration
  LocalTime: typeof LocalTime
  Time: typeof Time
  Date: typeof Date
  LocalDateTime: typeof LocalDateTime
  DateTime: typeof DateTime
  Integer: typeof Integer
  RxSession: typeof RxSession
  RxTransaction: typeof RxTransaction
  RxManagedTransaction: typeof RxManagedTransaction
  RxResult: typeof RxResult
}

declare const session: {
  READ: typeof READ
  WRITE: typeof WRITE
}

declare const integer: {
  toNumber: typeof toNumber
  toString: typeof toString
  inSafeRange: typeof inSafeRange
}

declare const spatial: {
  isPoint: typeof isPoint
}

declare const temporal: {
  isDuration: typeof isDuration
  isLocalTime: typeof isLocalTime
  isTime: typeof isTime
  isDate: typeof isDate
  isLocalDateTime: typeof isLocalDateTime
  isDateTime: typeof isDateTime
}

declare const graph: {
  isNode: typeof isNode
  isPath: typeof isPath
  isPathSegment: typeof isPathSegment
  isRelationship: typeof isRelationship
  isUnboundRelationship: typeof isUnboundRelationship
}

/*
 Both default and non-default exports declare all visible types so that they can be used in client code like this:

 import neo4j from "neo4j-driver";
 const driver: neo4j.Driver = neo4j.driver("bolt://localhost");
 const session: neo4j.Session = driver.session();
 ...
*/

declare const forExport: {
  authTokenManagers: typeof authTokenManagers
  driver: typeof driver
  hasReachableServer: typeof hasReachableServer
  int: typeof int
  isInt: typeof isInt
  integer: typeof integer
  auth: typeof auth
  types: typeof types
  session: typeof session
  routing: typeof routing
  error: typeof error
  graph: typeof graph
  spatial: typeof spatial
  temporal: typeof temporal
  Driver: typeof Driver
  AuthToken: AuthToken
  Config: Config
  EncryptionLevel: EncryptionLevel
  TrustStrategy: TrustStrategy
  SessionMode: SessionMode
  Neo4jError: typeof Neo4jError
  isRetriableError: typeof isRetriableError
  Node: typeof Node
  Relationship: typeof Relationship
  UnboundRelationship: typeof UnboundRelationship
  PathSegment: typeof PathSegment
  Path: typeof Path
  Integer: typeof Integer
  Record: typeof Record
  Result: typeof Result
  EagerResult: typeof EagerResult
  QueryResult: QueryResult
  ResultObserver: ResultObserver
  ResultSummary: typeof ResultSummary
  Plan: typeof Plan
  ProfiledPlan: typeof ProfiledPlan
  QueryStatistics: typeof QueryStatistics
  Notification: typeof Notification
  GqlStatusObject: typeof GqlStatusObject
  ServerInfo: typeof ServerInfo
  NotificationPosition: NotificationPosition
  Session: typeof Session
  Transaction: typeof Transaction
  ManagedTransaction: typeof ManagedTransaction
  Point: typeof Point
  isPoint: typeof isPoint
  Duration: typeof Duration
  LocalTime: typeof LocalTime
  Time: typeof Time
  Date: typeof Date
  LocalDateTime: typeof LocalDateTime
  DateTime: typeof DateTime
  RxSession: typeof RxSession
  RxTransaction: typeof RxTransaction
  RxManagedTransaction: typeof RxManagedTransaction
  RxResult: typeof RxResult
  isDuration: typeof isDuration
  isLocalTime: typeof isLocalTime
  isTime: typeof isTime
  isDate: typeof isDate
  isLocalDateTime: typeof isLocalDateTime
  isDateTime: typeof isDateTime
  isNode: typeof isNode
  isPath: typeof isPath
  isPathSegment: typeof isPathSegment
  isRelationship: typeof isRelationship
  isUnboundRelationship: typeof isUnboundRelationship
  bookmarkManager: typeof bookmarkManager
  resultTransformers: typeof resultTransformers
  notificationCategory: typeof notificationCategory
  notificationClassification: typeof notificationClassification
  notificationSeverityLevel: typeof notificationSeverityLevel
  notificationFilterDisabledCategory: typeof notificationFilterDisabledCategory
  notificationFilterDisabledClassification: typeof notificationFilterDisabledClassification
  notificationFilterMinimumSeverityLevel: typeof notificationFilterMinimumSeverityLevel
  logging: typeof logging
  clientCertificateProviders: typeof clientCertificateProviders
}

export {
  authTokenManagers,
  driver,
  hasReachableServer,
  int,
  isInt,
  integer,
  auth,
  types,
  session,
  routing,
  error,
  graph,
  spatial,
  temporal,
  Driver,
  AuthToken,
  Config,
  EncryptionLevel,
  TrustStrategy,
  SessionMode,
  Neo4jError,
  isRetriableError,
  Node,
  Relationship,
  UnboundRelationship,
  PathSegment,
  Path,
  Integer,
  Record,
  Result,
  EagerResult,
  QueryResult,
  ResultObserver,
  ResultSummary,
  Plan,
  ProfiledPlan,
  QueryStatistics,
  Notification,
  GqlStatusObject,
  ServerInfo,
  NotificationPosition,
  Session,
  Transaction,
  ManagedTransaction,
  Point,
  isPoint,
  Duration,
  LocalTime,
  Time,
  Date,
  LocalDateTime,
  DateTime,
  RxSession,
  RxTransaction,
  RxManagedTransaction,
  RxResult,
  isDuration,
  isLocalTime,
  isTime,
  isDate,
  isLocalDateTime,
  isDateTime,
  isNode,
  isPath,
  isPathSegment,
  isRelationship,
  isUnboundRelationship,
  bookmarkManager,
  resultTransformers,
  notificationCategory,
  notificationClassification,
  notificationSeverityLevel,
  notificationFilterDisabledCategory,
  notificationFilterDisabledClassification,
  notificationFilterMinimumSeverityLevel,
  logging,
  clientCertificateProviders
}

export type {
  AuthTokenManagers,
  BookmarkManager,
  BookmarkManagerConfig,
  SessionConfig,
  QueryConfig,
  RoutingControl,
  RecordShape,
  ResultTransformer,
  NotificationCategory,
  NotificationClassification,
  NotificationSeverityLevel,
  NotificationFilter,
  NotificationFilterDisabledCategory,
  NotificationFilterDisabledClassification,
  NotificationFilterMinimumSeverityLevel,
  AuthTokenManager,
  AuthTokenAndExpiration,
  ClientCertificate,
  ClientCertificateProvider,
  ClientCertificateProviders,
  RotatingClientCertificateProvider
}

export default forExport