move tx-config to core

Author: bigmontz

core/src/internal/index.ts

@@ -23,5 +23,14 @@ import * as observer from './observers'
 import * as bookmark from './bookmark'
 import * as constants from './constants'
 import * as connectionHolder from './connection-holder'
+import * as txConfig from './tx-config'
 
-export { util, temporalUtil, observer, bookmark, constants, connectionHolder }
+export {
+  util,
+  temporalUtil,
+  observer,
+  bookmark,
+  constants,
+  connectionHolder,
+  txConfig
+}

core/src/internal/tx-config.ts

@@ -0,0 +1,100 @@
+/**
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * 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 * as util from './util'
+import { newError } from '../error'
+import Integer, { int } from '../integer'
+
+/**
+ * Internal holder of the transaction configuration.
+ * It performs input validation and value conversion for further serialization by the Bolt protocol layer.
+ * Users of the driver provide transaction configuration as regular objects `{timeout: 10, metadata: {key: 'value'}}`.
+ * Driver converts such objects to {@link TxConfig} immediately and uses converted values everywhere.
+ */
+export class TxConfig {
+  readonly timeout: Integer | null
+  readonly metadata: any
+
+  /**
+   * @constructor
+   * @param {Object} config the raw configuration object.
+   */
+  constructor(config: any) {
+    assertValidConfig(config)
+    this.timeout = extractTimeout(config)
+    this.metadata = extractMetadata(config)
+  }
+
+  /**
+   * Get an empty config object.
+   * @return {TxConfig} an empty config.
+   */
+  static empty(): TxConfig {
+    return EMPTY_CONFIG
+  }
+
+  /**
+   * Check if this config object is empty. I.e. has no configuration values specified.
+   * @return {boolean} `true` if this object is empty, `false` otherwise.
+   */
+  isEmpty(): boolean {
+    return Object.values(this).every(value => value == null)
+  }
+}
+
+const EMPTY_CONFIG = new TxConfig({})
+
+/**
+ * @return {Integer|null}
+ */
+function extractTimeout(config: any): Integer | null {
+  if (util.isObject(config) && (config.timeout || config.timeout === 0)) {
+    util.assertNumberOrInteger(config.timeout, 'Transaction timeout')
+    const timeout = int(config.timeout)
+    if (timeout.isZero()) {
+      throw newError('Transaction timeout should not be zero')
+    }
+    if (timeout.isNegative()) {
+      throw newError('Transaction timeout should not be negative')
+    }
+    return timeout
+  }
+  return null
+}
+
+/**
+ * @return {object|null}
+ */
+function extractMetadata(config: any): any {
+  if (util.isObject(config) && config.metadata) {
+    const metadata = config.metadata
+    util.assertObject(metadata, 'config.metadata')
+    if (Object.keys(metadata).length !== 0) {
+      // not an empty object
+      return metadata
+    }
+  }
+  return null
+}
+
+function assertValidConfig(config: any): void {
+  if (config) {
+    util.assertObject(config, 'Transaction config')
+  }
+}

src/internal/tx-config.js

@@ -17,80 +17,6 @@
  * limitations under the License.
  */
 
-import * as util from './util'
-import { int, newError } from 'neo4j-driver-core'
+import { internal } from 'neo4j-driver-core'
 
-/**
- * Internal holder of the transaction configuration.
- * It performs input validation and value conversion for further serialization by the Bolt protocol layer.
- * Users of the driver provide transaction configuration as regular objects `{timeout: 10, metadata: {key: 'value'}}`.
- * Driver converts such objects to {@link TxConfig} immediately and uses converted values everywhere.
- */
-export default class TxConfig {
-  /**
-   * @constructor
-   * @param {Object} config the raw configuration object.
-   */
-  constructor (config) {
-    assertValidConfig(config)
-    this.timeout = extractTimeout(config)
-    this.metadata = extractMetadata(config)
-  }
-
-  /**
-   * Get an empty config object.
-   * @return {TxConfig} an empty config.
-   */
-  static empty () {
-    return EMPTY_CONFIG
-  }
-
-  /**
-   * Check if this config object is empty. I.e. has no configuration values specified.
-   * @return {boolean} `true` if this object is empty, `false` otherwise.
-   */
-  isEmpty () {
-    return Object.values(this).every(value => value == null)
-  }
-}
-
-const EMPTY_CONFIG = new TxConfig({})
-
-/**
- * @return {Integer|null}
- */
-function extractTimeout (config) {
-  if (util.isObject(config) && (config.timeout || config.timeout === 0)) {
-    util.assertNumberOrInteger(config.timeout, 'Transaction timeout')
-    const timeout = int(config.timeout)
-    if (timeout.isZero()) {
-      throw newError('Transaction timeout should not be zero')
-    }
-    if (timeout.isNegative()) {
-      throw newError('Transaction timeout should not be negative')
-    }
-    return timeout
-  }
-  return null
-}
-
-/**
- * @return {object|null}
- */
-function extractMetadata (config) {
-  if (util.isObject(config) && config.metadata) {
-    const metadata = config.metadata
-    util.assertObject(metadata)
-    if (Object.keys(metadata).length !== 0) {
-      // not an empty object
-      return metadata
-    }
-  }
-  return null
-}
-
-function assertValidConfig (config) {
-  if (config) {
-    util.assertObject(config, 'Transaction config')
-  }
-}
+export default internal.txConfig.TxConfig