Export validateConfiguration

Author: gionatamettifogo

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sqlitecloud/drivers",
-  "version": "0.0.38",
+  "version": "0.0.40",
   "description": "SQLiteCloud drivers for Typescript/Javascript in edge, web and node clients",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",

src/connection.ts

@@ -3,12 +3,7 @@
  */
 
 import { SQLiteCloudConfig, SQLiteCloudError, ErrorCallback, ResultsCallback } from './types'
-import { parseConnectionString, parseBoolean, isBrowser } from './utilities'
-
-/** Default timeout value for queries */
-export const DEFAULT_TIMEOUT = 300 * 1000
-/** Default tls connection port */
-export const DEFAULT_PORT = 9960
+import { validateConfiguration, isBrowser } from './utilities'
 
 /**
  * Base class for SQLiteCloudConnection handles basics and defines methods.
@@ -18,9 +13,9 @@ export class SQLiteCloudConnection {
   /** Parse and validate provided connectionString or configuration */
   constructor(config: SQLiteCloudConfig | string, callback?: ErrorCallback) {
     if (typeof config === 'string') {
-      this.config = this.validateConfiguration({ connectionString: config })
+      this.config = validateConfiguration({ connectionString: config })
     } else {
-      this.config = this.validateConfiguration(config)
+      this.config = validateConfiguration(config)
     }
 
     // connect transport layer to server
@@ -93,41 +88,6 @@ export class SQLiteCloudConnection {
   // private methods
   //
 
-  /** Validate configuration, apply defaults, throw if something is missing or misconfigured */
-  protected validateConfiguration(config: SQLiteCloudConfig): SQLiteCloudConfig {
-    if (config.connectionString) {
-      config = {
-        ...config,
-        ...parseConnectionString(config.connectionString),
-        connectionString: config.connectionString // keep original connection string
-      }
-    }
-
-    // apply defaults where needed
-    config.port ||= DEFAULT_PORT
-    config.timeout = config.timeout && config.timeout > 0 ? config.timeout : DEFAULT_TIMEOUT
-    config.clientId ||= 'SQLiteCloud'
-
-    config.verbose = parseBoolean(config.verbose)
-    config.noBlob = parseBoolean(config.noBlob)
-    config.compression = parseBoolean(config.compression)
-    config.createDatabase = parseBoolean(config.createDatabase)
-    config.nonlinearizable = parseBoolean(config.nonlinearizable)
-
-    if (!config.username || !config.password || !config.host) {
-      console.error('SQLiteCloudConnection.validateConfiguration - missing arguments', config)
-      throw new SQLiteCloudError('The user, password and host arguments must be specified.', { errorCode: 'ERR_MISSING_ARGS' })
-    }
-
-    if (!config.connectionString) {
-      // build connection string from configuration, values are already validated
-      // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-      config.connectionString = `sqlitecloud://${config.username}:${config.password}@${config.host}:${config.port}/${config.database}`
-    }
-
-    return config
-  }
-
   /** Will log to console if verbose mode is enabled */
   protected log(message: string, ...optionalParams: any[]): void {
     if (this.config.verbose) {

src/index.ts

@@ -7,6 +7,6 @@ export { Statement } from './statement'
 export { SQLiteCloudConfig, SQLCloudRowsetMetadata, SQLiteCloudError, ErrorCallback } from './types'
 export { SQLiteCloudRowset, SQLiteCloudRow } from './rowset'
 export { SQLiteCloudConnection } from './connection'
-export { escapeSqlParameter, prepareSql } from './utilities'
+export { escapeSqlParameter, prepareSql, parseConnectionString, validateConfiguration } from './utilities'
 export { WebSocketTransport } from './transport-ws'
 export { TlsSocketTransport } from './transport-tls'

src/transport-tls.ts

@@ -126,7 +126,7 @@ export class TlsSocketTransport implements ConnectionTransport {
 
     let buffer = Buffer.alloc(0)
     const rowsetChunks: Buffer[] = []
-    const startedOn = new Date()
+    // const startedOn = new Date()
 
     // define what to do if an answer does not arrive within the set timeout
     let socketTimeout: number

src/types.ts

@@ -4,6 +4,11 @@
 
 import tls from 'tls'
 
+/** Default timeout value for queries */
+export const DEFAULT_TIMEOUT = 300 * 1000
+/** Default tls connection port */
+export const DEFAULT_PORT = 9960
+
 /** Configuration for SQLite cloud connection */
 export interface SQLiteCloudConfig {
   /** Connection string in the form of sqlitecloud://user:password@host:port/database?options */

src/utilities.ts

@@ -2,7 +2,7 @@
 // utilities.ts - utility methods to manipulate SQL statements
 //
 
-import { SQLiteCloudConfig, SQLiteCloudError, SQLiteCloudDataTypes } from './types'
+import { SQLiteCloudConfig, SQLiteCloudError, SQLiteCloudDataTypes, DEFAULT_PORT, DEFAULT_TIMEOUT } from './types'
 
 //
 // determining running environment, thanks to browser-or-node
@@ -115,6 +115,45 @@ export function popCallback<T extends ErrorCallback = ErrorCallback>(
   return { args: remaining }
 }
 
+//
+// configuration validation
+//
+
+/** Validate configuration, apply defaults, throw if something is missing or misconfigured */
+export function validateConfiguration(config: SQLiteCloudConfig): SQLiteCloudConfig {
+  if (config.connectionString) {
+    config = {
+      ...config,
+      ...parseConnectionString(config.connectionString),
+      connectionString: config.connectionString // keep original connection string
+    }
+  }
+
+  // apply defaults where needed
+  config.port ||= DEFAULT_PORT
+  config.timeout = config.timeout && config.timeout > 0 ? config.timeout : DEFAULT_TIMEOUT
+  config.clientId ||= 'SQLiteCloud'
+
+  config.verbose = parseBoolean(config.verbose)
+  config.noBlob = parseBoolean(config.noBlob)
+  config.compression = parseBoolean(config.compression)
+  config.createDatabase = parseBoolean(config.createDatabase)
+  config.nonlinearizable = parseBoolean(config.nonlinearizable)
+
+  if (!config.username || !config.password || !config.host) {
+    console.error('SQLiteCloudConnection.validateConfiguration - missing arguments', config)
+    throw new SQLiteCloudError('The user, password and host arguments must be specified.', { errorCode: 'ERR_MISSING_ARGS' })
+  }
+
+  if (!config.connectionString) {
+    // build connection string from configuration, values are already validated
+    // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+    config.connectionString = `sqlitecloud://${config.username}:${config.password}@${config.host}:${config.port}/${config.database}`
+  }
+
+  return config
+}
+
 /** Parse connectionString like sqlitecloud://username:password@host:port/database?option1=xxx&option2=xxx into its components */
 export function parseConnectionString(connectionString: string): SQLiteCloudConfig {
   try {