Fix ProtocolVersion API docs (#1346)

Author: MaxAake

packages/core/src/connection-provider.ts

@@ -18,7 +18,7 @@
 
 import Connection from './connection'
 import { bookmarks } from './internal'
-import { ProtocolVersion } from './internal/protocol-version'
+import { ProtocolVersion } from './protocol-version'
 import { ServerInfo } from './result-summary'
 import { AuthToken } from './types'
 

packages/core/src/connection.ts

@@ -19,7 +19,7 @@
 import { Bookmarks } from './internal/bookmarks'
 import { AccessMode, TelemetryApis } from './internal/constants'
 import { ResultStreamObserver } from './internal/observers'
-import { ProtocolVersion } from './internal/protocol-version'
+import { ProtocolVersion } from './protocol-version'
 import { TxConfig } from './internal/tx-config'
 import NotificationFilter from './notification-filter'
 

packages/core/src/driver.ts

@@ -48,7 +48,7 @@ import { newError } from './error'
 import NotificationFilter from './notification-filter'
 import HomeDatabaseCache from './internal/homedb-cache'
 import { cacheKey } from './internal/auth-util'
-import { ProtocolVersion } from './internal/protocol-version'
+import { ProtocolVersion } from './protocol-version'
 
 const DEFAULT_MAX_CONNECTION_LIFETIME: number = 60 * 60 * 1000 // 1 hour
 

packages/core/src/index.ts

@@ -102,7 +102,7 @@ import * as json from './json'
 import resultTransformers, { ResultTransformer } from './result-transformers'
 import ClientCertificate, { clientCertificateProviders, ClientCertificateProvider, ClientCertificateProviders, RotatingClientCertificateProvider, resolveCertificateProvider } from './client-certificate'
 import * as internal from './internal' // todo: removed afterwards
-import { ProtocolVersion } from './internal/protocol-version'
+import { ProtocolVersion } from './protocol-version'
 import Vector, { VectorType, vector, isVector } from './vector'
 import { StandardCase } from './mapping.nameconventions'
 import { Rule, Rules, RecordObjectMapping } from './mapping.highlevel'
@@ -292,7 +292,7 @@ export {
   RecordObjectMapping,
   StandardCase,
   UnsupportedType,
-  isUnsupportedType,
+  isUnsupportedType
 }
 
 export type {

packages/core/src/internal/constants.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import { ProtocolVersion } from './protocol-version'
+import { ProtocolVersion } from '../protocol-version'
 
 const FETCH_ALL = -1
 const DEFAULT_POOL_ACQUISITION_TIMEOUT = 60 * 1000 // 60 seconds

packages/core/src/internal/protocol-version.ts

@@ -0,0 +1,106 @@
+/**
+ * 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.
+ */
+
+/**
+ *
+ * @access public
+ * @class A class representing a protocol version the driver is using to communicate with the server.
+ * @param {number} major the major version of the protocol.
+ * @param {number} minor the minor version of the protocol.
+ */
+export class ProtocolVersion {
+  private readonly major: number
+  private readonly minor: number
+  constructor (major: number, minor: number) {
+    this.major = major
+    this.minor = minor
+  }
+
+  /**
+   *
+   * @returns {number} The major version of the protocol
+   */
+  getMajor (): number {
+    return this.major
+  }
+
+  /**
+   * @returns {number} The minor version of the protocol
+   */
+  getMinor (): number {
+    return this.major
+  }
+
+  /**
+   *
+   * @param {ProtocolVersion | {major: number, minor: number}} other the protocol version to compare to
+   * @returns {boolean} If this version semantically smaller than the other version.
+   */
+  isLessThan (other: ProtocolVersion): boolean {
+    if (this.major < other.major) {
+      return true
+    } else if (this.major === other.major && this.minor < other.minor) {
+      return true
+    }
+    return false
+  }
+
+  /**
+   *
+   * @param {ProtocolVersion | {major: number, minor: number}} other the protocol version to compare to
+   * @returns {boolean} If this version is semantically larger than the other version.
+   */
+  isGreaterThan (other: ProtocolVersion): boolean {
+    if (this.major > other.major) {
+      return true
+    } else if (this.major === other.major && this.minor > other.minor) {
+      return true
+    }
+    return false
+  }
+
+  /**
+   *
+   * @param {ProtocolVersion | {major: number, minor: number}} other the protocol version to compare to
+   * @returns {boolean} if this version is semantically larger or equal to the other version.
+   */
+  isGreaterOrEqualTo (other: ProtocolVersion): boolean {
+    return !this.isLessThan(other)
+  }
+
+  /**
+   *
+   * @param {ProtocolVersion | {major: number, minor: number}} other the protocol version to compare to
+   * @returns {boolean} if this version is semantically smaller or equal to the other version.
+   */
+  isLessOrEqualTo (other: ProtocolVersion): boolean {
+    return !this.isGreaterThan(other)
+  }
+
+  /**
+   *
+   * @param {ProtocolVersion | {major: number, minor: number}} other the protocol version to compare to
+   * @returns {boolean} If this version is the equal to the other version.
+   */
+  isEqualTo (other: ProtocolVersion): boolean {
+    return this.major === other.major && this.minor === other.minor
+  }
+
+  toString (): string {
+    return this.major.toString() + '.' + this.minor.toString()
+  }
+}

packages/core/src/protocol-version.ts

@@ -19,7 +19,7 @@ import Integer from './integer'
 import { NumberOrInteger } from './graph-types'
 import { util } from './internal'
 import GqlStatusObject, { Notification, buildGqlStatusObjectFromMetadata, buildNotificationsFromMetadata } from './notification'
-import { ProtocolVersion } from './internal/protocol-version'
+import { ProtocolVersion } from './protocol-version'
 
 /**
  * A ResultSummary instance contains structured metadata for a {@link Result}.

packages/core/src/result-summary.ts

@@ -25,7 +25,7 @@ import { LogLevel } from '../src/types'
 import resultTransformers from '../src/result-transformers'
 import Record, { RecordShape } from '../src/record'
 import { invalidNotificationFilters, validNotificationFilters } from './utils/notification-filters.fixtures'
-import { ProtocolVersion } from '../src/internal/protocol-version'
+import { ProtocolVersion } from '../src/protocol-version'
 
 describe('Driver', () => {
   let driver: Driver | null

packages/core/test/driver.test.ts

@@ -16,7 +16,7 @@
  */
 
 import { int } from '../src'
-import { ProtocolVersion } from '../src/internal/protocol-version'
+import { ProtocolVersion } from '../src/protocol-version'
 import {
   ServerInfo,
   ProfiledPlan,