@sqlitecloud/drivers 0.0.39 → 0.0.50

package/lib/drivers/protocol.js

@@ -0,0 +1,291 @@
+"use strict";
+//
+// protocol.ts - low level protocol handling for SQLiteCloud transport
+//
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatCommand = exports.popData = exports.parseRowsetChunks = exports.bufferEndsWith = exports.bufferStartsWith = exports.parseRowsetHeader = exports.parseArray = exports.parseError = exports.decompressBuffer = exports.parseCommandLength = exports.hasCommandLength = exports.ROWSET_CHUNKS_END = exports.CMD_ARRAY = exports.CMD_COMMAND = exports.CMD_COMPRESSED = exports.CMD_BLOB = exports.CMD_NULL = exports.CMD_JSON = exports.CMD_ROWSET_CHUNK = exports.CMD_ROWSET = exports.CMD_FLOAT = exports.CMD_INT = exports.CMD_ERROR = exports.CMD_ZEROSTRING = exports.CMD_STRING = void 0;
+const types_1 = require("./types");
+const rowset_1 = require("./rowset");
+const lz4 = require('lz4js');
+// The server communicates with clients via commands defined in
+// SQLiteCloud Server Protocol (SCSP), see more at:
+// https://github.com/sqlitecloud/sdk/blob/master/PROTOCOL.md
+exports.CMD_STRING = '+';
+exports.CMD_ZEROSTRING = '!';
+exports.CMD_ERROR = '-';
+exports.CMD_INT = ':';
+exports.CMD_FLOAT = ',';
+exports.CMD_ROWSET = '*';
+exports.CMD_ROWSET_CHUNK = '/';
+exports.CMD_JSON = '#';
+exports.CMD_NULL = '_';
+exports.CMD_BLOB = '$';
+exports.CMD_COMPRESSED = '%';
+exports.CMD_COMMAND = '^';
+exports.CMD_ARRAY = '=';
+// const CMD_RAWJSON = '{'
+// const CMD_PUBSUB = '|'
+// const CMD_RECONNECT = '@'
+// To mark the end of the Rowset, the special string /LEN 0 0 0   is sent (LEN is always 6 in this case)
+// https://github.com/sqlitecloud/sdk/blob/master/PROTOCOL.md#scsp-rowset-chunk
+exports.ROWSET_CHUNKS_END = '/6 0 0 0 ';
+//
+// utility functions
+//
+/** Analyze first character to check if corresponding data type has LEN */
+function hasCommandLength(firstCharacter) {
+    return firstCharacter == exports.CMD_INT || firstCharacter == exports.CMD_FLOAT || firstCharacter == exports.CMD_NULL ? false : true;
+}
+exports.hasCommandLength = hasCommandLength;
+/** Analyze a command with explict LEN and extract it */
+function parseCommandLength(data) {
+    return parseInt(data.subarray(1, data.indexOf(' ')).toString('utf8'));
+}
+exports.parseCommandLength = parseCommandLength;
+/** Receive a compressed buffer, decompress with lz4, return buffer and datatype */
+function decompressBuffer(buffer) {
+    const spaceIndex = buffer.indexOf(' ');
+    buffer = buffer.subarray(spaceIndex + 1);
+    // extract compressed size
+    const compressedSize = parseInt(buffer.subarray(0, buffer.indexOf(' ') + 1).toString('utf8'));
+    buffer = buffer.subarray(buffer.indexOf(' ') + 1);
+    // extract decompressed size
+    const decompressedSize = parseInt(buffer.subarray(0, buffer.indexOf(' ') + 1).toString('utf8'));
+    buffer = buffer.subarray(buffer.indexOf(' ') + 1);
+    // extract compressed dataType
+    const dataType = buffer.subarray(0, 1).toString('utf8');
+    const decompressedBuffer = Buffer.alloc(decompressedSize);
+    const compressedBuffer = buffer.subarray(buffer.length - compressedSize);
+    // lz4js library is javascript and doesn't have types so we silence the type check
+    // eslint-disable-next-line
+    const decompressionResult = lz4.decompressBlock(compressedBuffer, decompressedBuffer, 0, compressedSize, 0);
+    buffer = Buffer.concat([buffer.subarray(0, buffer.length - compressedSize), decompressedBuffer]);
+    if (decompressionResult <= 0 || decompressionResult !== decompressedSize) {
+        throw new Error(`lz4 decompression error at offset ${decompressionResult}`);
+    }
+    return { buffer, dataType };
+}
+exports.decompressBuffer = decompressBuffer;
+/** Parse error message or extended error message */
+function parseError(buffer, spaceIndex) {
+    const errorBuffer = buffer.subarray(spaceIndex + 1);
+    const errorString = errorBuffer.toString('utf8');
+    const parts = errorString.split(' ');
+    let errorCodeStr = parts.shift() || '0'; // Default errorCode is '0' if not present
+    let extErrCodeStr = '0'; // Default extended error code
+    let offsetCodeStr = '-1'; // Default offset code
+    // Split the errorCode by ':' to check for extended error codes
+    const errorCodeParts = errorCodeStr.split(':');
+    errorCodeStr = errorCodeParts[0];
+    if (errorCodeParts.length > 1) {
+        extErrCodeStr = errorCodeParts[1];
+        if (errorCodeParts.length > 2) {
+            offsetCodeStr = errorCodeParts[2];
+        }
+    }
+    // Rest of the error string is the error message
+    const errorMessage = parts.join(' ');
+    // Parse error codes to integers safely, defaulting to 0 if NaN
+    const errorCode = parseInt(errorCodeStr);
+    const extErrCode = parseInt(extErrCodeStr);
+    const offsetCode = parseInt(offsetCodeStr);
+    // create an Error object and add the custom properties
+    throw new types_1.SQLiteCloudError(errorMessage, {
+        errorCode: errorCode.toString(),
+        externalErrorCode: extErrCode.toString(),
+        offsetCode
+    });
+}
+exports.parseError = parseError;
+/** Parse an array of items (each of which will be parsed by type separately) */
+function parseArray(buffer, spaceIndex) {
+    const parsedData = [];
+    const array = buffer.subarray(spaceIndex + 1, buffer.length);
+    const numberOfItems = parseInt(array.subarray(0, spaceIndex - 2).toString('utf8'));
+    let arrayItems = array.subarray(array.indexOf(' ') + 1, array.length);
+    for (let i = 0; i < numberOfItems; i++) {
+        const { data, fwdBuffer: buffer } = popData(arrayItems);
+        parsedData.push(data);
+        arrayItems = buffer;
+    }
+    return parsedData;
+}
+exports.parseArray = parseArray;
+/** Parse header in a rowset or chunk of a chunked rowset */
+function parseRowsetHeader(buffer) {
+    const index = parseInt(buffer.subarray(0, buffer.indexOf(':') + 1).toString());
+    buffer = buffer.subarray(buffer.indexOf(':') + 1);
+    // extract rowset header
+    const { data, fwdBuffer } = popIntegers(buffer, 3);
+    return {
+        index,
+        metadata: {
+            version: data[0],
+            numberOfRows: data[1],
+            numberOfColumns: data[2],
+            columns: []
+        },
+        fwdBuffer
+    };
+}
+exports.parseRowsetHeader = parseRowsetHeader;
+/** Extract column names and, optionally, more metadata out of a rowset's header */
+function parseRowsetColumnsMetadata(buffer, metadata) {
+    function popForward() {
+        const { data, fwdBuffer: fwdBuffer } = popData(buffer); // buffer in parent scope
+        buffer = fwdBuffer;
+        return data;
+    }
+    for (let i = 0; i < metadata.numberOfColumns; i++) {
+        metadata.columns.push({ name: popForward() });
+    }
+    // extract additional metadata if rowset has version 2
+    if (metadata.version == 2) {
+        for (let i = 0; i < metadata.numberOfColumns; i++)
+            metadata.columns[i].type = popForward();
+        for (let i = 0; i < metadata.numberOfColumns; i++)
+            metadata.columns[i].database = popForward();
+        for (let i = 0; i < metadata.numberOfColumns; i++)
+            metadata.columns[i].table = popForward();
+        for (let i = 0; i < metadata.numberOfColumns; i++)
+            metadata.columns[i].column = popForward(); // original column name
+        for (let i = 0; i < metadata.numberOfColumns; i++)
+            metadata.columns[i].notNull = popForward();
+        for (let i = 0; i < metadata.numberOfColumns; i++)
+            metadata.columns[i].primaryKey = popForward();
+        for (let i = 0; i < metadata.numberOfColumns; i++)
+            metadata.columns[i].autoIncrement = popForward();
+    }
+    return buffer;
+}
+/** Parse a regular rowset (no chunks) */
+function parseRowset(buffer, spaceIndex) {
+    buffer = buffer.subarray(spaceIndex + 1, buffer.length);
+    const { metadata, fwdBuffer } = parseRowsetHeader(buffer);
+    buffer = parseRowsetColumnsMetadata(fwdBuffer, metadata);
+    // decode each rowset item
+    const data = [];
+    for (let j = 0; j < metadata.numberOfRows * metadata.numberOfColumns; j++) {
+        const { data: rowData, fwdBuffer } = popData(buffer);
+        data.push(rowData);
+        buffer = fwdBuffer;
+    }
+    console.assert(data && data.length === metadata.numberOfRows * metadata.numberOfColumns, 'SQLiteCloudConnection.parseRowset - invalid rowset data');
+    return new rowset_1.SQLiteCloudRowset(metadata, data);
+}
+function bufferStartsWith(buffer, prefix) {
+    return buffer.length >= prefix.length && buffer.subarray(0, prefix.length).toString('utf8') === prefix;
+}
+exports.bufferStartsWith = bufferStartsWith;
+function bufferEndsWith(buffer, suffix) {
+    return buffer.length >= suffix.length && buffer.subarray(buffer.length - suffix.length, buffer.length).toString('utf8') === suffix;
+}
+exports.bufferEndsWith = bufferEndsWith;
+/**
+ * Parse a chunk of a chunked rowset command, eg:
+ * *LEN 0:VERS NROWS NCOLS DATA
+ * @see https://github.com/sqlitecloud/sdk/blob/master/PROTOCOL.md#scsp-rowset-chunk
+ */
+function parseRowsetChunks(buffers) {
+    let buffer = Buffer.concat(buffers);
+    if (!bufferStartsWith(buffer, exports.CMD_ROWSET_CHUNK) || !bufferEndsWith(buffer, exports.ROWSET_CHUNKS_END)) {
+        throw new Error('SQLiteCloudConnection.parseRowsetChunks - invalid chunks buffer');
+    }
+    let metadata = { version: 1, numberOfColumns: 0, numberOfRows: 0, columns: [] };
+    const data = [];
+    // validate and skip data type
+    const dataType = buffer.subarray(0, 1).toString();
+    console.assert(dataType === exports.CMD_ROWSET_CHUNK);
+    buffer = buffer.subarray(buffer.indexOf(' ') + 1);
+    while (buffer.length > 0 && !bufferStartsWith(buffer, exports.ROWSET_CHUNKS_END)) {
+        // chunk header, eg: 0:VERS NROWS NCOLS
+        const { index: chunkIndex, metadata: chunkMetadata, fwdBuffer } = parseRowsetHeader(buffer);
+        buffer = fwdBuffer;
+        // first chunk? extract columns metadata
+        if (chunkIndex === 1) {
+            metadata = chunkMetadata;
+            buffer = parseRowsetColumnsMetadata(buffer, metadata);
+        }
+        else {
+            metadata.numberOfRows += chunkMetadata.numberOfRows;
+        }
+        // extract single rowset row
+        for (let k = 0; k < chunkMetadata.numberOfRows * metadata.numberOfColumns; k++) {
+            const { data: itemData, fwdBuffer } = popData(buffer);
+            data.push(itemData);
+            buffer = fwdBuffer;
+        }
+    }
+    console.assert(data && data.length === metadata.numberOfRows * metadata.numberOfColumns, 'parseRowsetChunks - invalid rowset data');
+    const rowset = new rowset_1.SQLiteCloudRowset(metadata, data);
+    // console.debug(`parseRowsetChunks - ${rowset.numberOfRows} rows, ${rowset.numberOfColumns} columns`)
+    return rowset;
+}
+exports.parseRowsetChunks = parseRowsetChunks;
+/** Pop one or more space separated integers from beginning of buffer, move buffer forward */
+function popIntegers(buffer, numberOfIntegers = 1) {
+    const data = [];
+    for (let i = 0; i < numberOfIntegers; i++) {
+        const spaceIndex = buffer.indexOf(' ');
+        data[i] = parseInt(buffer.subarray(0, spaceIndex).toString());
+        buffer = buffer.subarray(spaceIndex + 1);
+    }
+    return { data, fwdBuffer: buffer };
+}
+/** Parse command, extract its data, return the data and the buffer moved to the first byte after the command */
+function popData(buffer) {
+    function popResults(data) {
+        const fwdBuffer = buffer.subarray(commandEnd);
+        return { data, fwdBuffer };
+    }
+    // first character is the data type
+    console.assert(buffer && buffer instanceof Buffer);
+    const dataType = buffer.subarray(0, 1).toString('utf8');
+    console.assert(dataType !== exports.CMD_COMPRESSED, "Compressed data shouldn't be decompressed before parsing");
+    console.assert(dataType !== exports.CMD_ROWSET_CHUNK, 'Chunked data should be parsed by parseRowsetChunks');
+    let spaceIndex = buffer.indexOf(' ');
+    if (spaceIndex === -1) {
+        spaceIndex = buffer.length - 1;
+    }
+    let commandEnd = -1;
+    if (dataType === exports.CMD_INT || dataType === exports.CMD_FLOAT || dataType === exports.CMD_NULL) {
+        commandEnd = spaceIndex + 1;
+    }
+    else {
+        const commandLength = parseInt(buffer.subarray(1, spaceIndex).toString());
+        commandEnd = spaceIndex + 1 + commandLength;
+    }
+    switch (dataType) {
+        case exports.CMD_INT:
+            return popResults(parseInt(buffer.subarray(1, spaceIndex).toString()));
+        case exports.CMD_FLOAT:
+            return popResults(parseFloat(buffer.subarray(1, spaceIndex).toString()));
+        case exports.CMD_NULL:
+            return popResults(null);
+        case exports.CMD_STRING:
+            return popResults(buffer.subarray(spaceIndex + 1, commandEnd).toString('utf8'));
+        case exports.CMD_ZEROSTRING:
+            return popResults(buffer.subarray(spaceIndex + 1, commandEnd - 1).toString('utf8'));
+        case exports.CMD_COMMAND:
+            return popResults(buffer.subarray(spaceIndex + 1, commandEnd).toString('utf8'));
+        case exports.CMD_JSON:
+            return popResults(JSON.parse(buffer.subarray(spaceIndex + 1, commandEnd).toString('utf8')));
+        case exports.CMD_BLOB:
+            return popResults(buffer.subarray(spaceIndex + 1, commandEnd));
+        case exports.CMD_ARRAY:
+            return popResults(parseArray(buffer, spaceIndex));
+        case exports.CMD_ROWSET:
+            return popResults(parseRowset(buffer, spaceIndex));
+        case exports.CMD_ERROR:
+            parseError(buffer, spaceIndex); // throws custom error
+            break;
+    }
+    throw new TypeError(`Data type: ${dataType} is not defined in SCSP`);
+}
+exports.popData = popData;
+/** Format a command to be sent via SCSP protocol */
+function formatCommand(command) {
+    const commandLength = Buffer.byteLength(command, 'utf-8');
+    return `+${commandLength} ${command}`;
+}
+exports.formatCommand = formatCommand;

package/lib/drivers/queue.d.ts

@@ -0,0 +1,12 @@
+export type OperationCallback = (error: Error | null) => void;
+export type Operation = (done: OperationCallback) => void;
+export declare class OperationsQueue {
+    private queue;
+    private isProcessing;
+    /** Add operations to the queue, process immediately if possible, else wait for previous operations to complete */
+    enqueue(operation: Operation): void;
+    /** Clear the queue */
+    clear(): void;
+    /** Process the next operation in the queue */
+    private processNext;
+}

package/lib/drivers/queue.js

@@ -0,0 +1,42 @@
+"use strict";
+//
+// queue.ts - simple task queue used to linearize async operations
+//
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OperationsQueue = void 0;
+class OperationsQueue {
+    constructor() {
+        this.queue = [];
+        this.isProcessing = false;
+    }
+    /** Add operations to the queue, process immediately if possible, else wait for previous operations to complete */
+    enqueue(operation) {
+        this.queue.push(operation);
+        if (!this.isProcessing) {
+            this.processNext();
+        }
+    }
+    /** Clear the queue */
+    clear() {
+        this.queue = [];
+        this.isProcessing = false;
+    }
+    /** Process the next operation in the queue */
+    processNext() {
+        if (this.queue.length === 0) {
+            this.isProcessing = false;
+            return;
+        }
+        this.isProcessing = true;
+        const operation = this.queue.shift();
+        operation === null || operation === void 0 ? void 0 : operation(() => {
+            // could receive (error) => { ...
+            // if (error) {
+            //   console.warn('OperationQueue.processNext - error in operation', error)
+            // }
+            // process the next operation in the queue
+            this.processNext();
+        });
+    }
+}
+exports.OperationsQueue = OperationsQueue;

package/lib/{types.d.ts → drivers/types.d.ts}

@@ -4,6 +4,10 @@
 /// <reference types="node" />
 /// <reference types="node" />
 import tls from 'tls';
+/** Default timeout value for queries */
+export declare const DEFAULT_TIMEOUT: number;
+/** Default tls connection port */
+export declare 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 */
@@ -18,6 +22,8 @@ export interface SQLiteCloudConfig {
     host?: string;
     /** Port number for tls socket */
     port?: number;
+    /** Connect using plain TCP port, without TLS encryption, NOT RECOMMENDED, TEST ONLY */
+    insecure?: boolean;
     /** Optional query timeout passed directly to TLS socket */
     timeout?: number;
     /** Name of database to open */

package/lib/{types.js → drivers/types.js}

@@ -3,7 +3,11 @@
  * types.ts - shared types and interfaces
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SQLiteCloudArrayType = exports.SQLiteCloudError = void 0;
+exports.SQLiteCloudArrayType = exports.SQLiteCloudError = exports.DEFAULT_PORT = exports.DEFAULT_TIMEOUT = void 0;
+/** Default timeout value for queries */
+exports.DEFAULT_TIMEOUT = 300 * 1000;
+/** Default tls connection port */
+exports.DEFAULT_PORT = 9960;
 /** Custom error reported by SQLiteCloud drivers */
 class SQLiteCloudError extends Error {
     constructor(message, args) {

package/lib/{utilities.d.ts → drivers/utilities.d.ts}

@@ -1,6 +1,12 @@
 import { SQLiteCloudConfig, SQLiteCloudDataTypes } from './types';
 export declare const isBrowser: boolean;
 export declare const isNode: boolean;
+/** Messages going to the server are sometimes logged when error conditions occour and need to be stripped of user credentials  */
+export declare function anonimizeCommand(message: string): string;
+/** Strip message code in error of user credentials */
+export declare function anonimizeError(error: Error): Error;
+/** Initialization commands sent to database when connection is established */
+export declare function getInitializationCommands(config: SQLiteCloudConfig): string;
 /** Takes a generic value and escapes it so it can replace ? as a binding in a prepared SQL statement */
 export declare function escapeSqlParameter(param: SQLiteCloudDataTypes): string;
 /** Take a sql statement and replaces ? or $named parameters that are properly serialized and escaped. */
@@ -17,6 +23,8 @@ export declare function popCallback<T extends ErrorCallback = ErrorCallback>(arg
     callback?: T | undefined;
     complete?: ErrorCallback;
 };
+/** Validate configuration, apply defaults, throw if something is missing or misconfigured */
+export declare function validateConfiguration(config: SQLiteCloudConfig): SQLiteCloudConfig;
 /** Parse connectionString like sqlitecloud://username:password@host:port/database?option1=xxx&option2=xxx into its components */
 export declare function parseConnectionString(connectionString: string): SQLiteCloudConfig;
 /** Returns true if value is 1 or true */

package/lib/{utilities.js → drivers/utilities.js}

@@ -3,7 +3,7 @@
 // utilities.ts - utility methods to manipulate SQL statements
 //
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseBoolean = exports.parseConnectionString = exports.popCallback = exports.prepareSql = exports.escapeSqlParameter = exports.isNode = exports.isBrowser = void 0;
+exports.parseBoolean = exports.parseConnectionString = exports.validateConfiguration = exports.popCallback = exports.prepareSql = exports.escapeSqlParameter = exports.getInitializationCommands = exports.anonimizeError = exports.anonimizeCommand = exports.isNode = exports.isBrowser = void 0;
 const types_1 = require("./types");
 //
 // determining running environment, thanks to browser-or-node
@@ -14,6 +14,54 @@ exports.isNode = typeof process !== 'undefined' && process.versions != null && p
 //
 // utility methods
 //
+/** Messages going to the server are sometimes logged when error conditions occour and need to be stripped of user credentials  */
+function anonimizeCommand(message) {
+    // hide password in AUTH command if needed
+    message = message.replace(/USER \S+/, 'USER ******');
+    message = message.replace(/PASSWORD \S+?(?=;)/, 'PASSWORD ******');
+    message = message.replace(/HASH \S+?(?=;)/, 'HASH ******');
+    return message;
+}
+exports.anonimizeCommand = anonimizeCommand;
+/** Strip message code in error of user credentials */
+function anonimizeError(error) {
+    if (error === null || error === void 0 ? void 0 : error.message) {
+        error.message = anonimizeCommand(error.message);
+    }
+    return error;
+}
+exports.anonimizeError = anonimizeError;
+/** Initialization commands sent to database when connection is established */
+function getInitializationCommands(config) {
+    // first user authentication, then all other commands
+    let commands = `AUTH USER ${config.username || ''} ${config.passwordHashed ? 'HASH' : 'PASSWORD'} ${config.password || ''}; `;
+    if (config.database) {
+        if (config.createDatabase && !config.dbMemory) {
+            commands += `CREATE DATABASE ${config.database} IF NOT EXISTS; `;
+        }
+        commands += `USE DATABASE ${config.database}; `;
+    }
+    if (config.compression) {
+        commands += 'SET CLIENT KEY COMPRESSION TO 1; ';
+    }
+    if (config.nonlinearizable) {
+        commands += 'SET CLIENT KEY NONLINEARIZABLE TO 1; ';
+    }
+    if (config.noBlob) {
+        commands += 'SET CLIENT KEY NOBLOB TO 1; ';
+    }
+    if (config.maxData) {
+        commands += `SET CLIENT KEY MAXDATA TO ${config.maxData}; `;
+    }
+    if (config.maxRows) {
+        commands += `SET CLIENT KEY MAXROWS TO ${config.maxRows}; `;
+    }
+    if (config.maxRowset) {
+        commands += `SET CLIENT KEY MAXROWSET TO ${config.maxRowset}; `;
+    }
+    return commands;
+}
+exports.getInitializationCommands = getInitializationCommands;
 /** Takes a generic value and escapes it so it can replace ? as a binding in a prepared SQL statement */
 function escapeSqlParameter(param) {
     if (param === null || param === undefined) {
@@ -100,6 +148,38 @@ function popCallback(args) {
     return { args: remaining };
 }
 exports.popCallback = popCallback;
+//
+// configuration validation
+//
+/** Validate configuration, apply defaults, throw if something is missing or misconfigured */
+function validateConfiguration(config) {
+    console.assert(config, 'SQLiteCloudConnection.validateConfiguration - missing config');
+    if (config.connectionString) {
+        config = Object.assign(Object.assign(Object.assign({}, config), parseConnectionString(config.connectionString)), { connectionString: config.connectionString // keep original connection string
+         });
+    }
+    // apply defaults where needed
+    config.port || (config.port = types_1.DEFAULT_PORT);
+    config.timeout = config.timeout && config.timeout > 0 ? config.timeout : types_1.DEFAULT_TIMEOUT;
+    config.clientId || (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);
+    config.insecure = parseBoolean(config.insecure);
+    if (!config.username || !config.password || !config.host) {
+        console.error('SQLiteCloudConnection.validateConfiguration - missing arguments', config);
+        throw new types_1.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;
+}
+exports.validateConfiguration = validateConfiguration;
 /** Parse connectionString like sqlitecloud://username:password@host:port/database?option1=xxx&option2=xxx into its components */
 function parseConnectionString(connectionString) {
     try {

package/lib/index.d.ts

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

package/lib/index.js

@@ -1,25 +1,26 @@
 "use strict";
 //
-// index.ts - re-export public APIs
+// index.ts - export drivers classes, utilities, types
 //
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TlsSocketTransport = exports.WebSocketTransport = exports.parseConnectionString = exports.prepareSql = exports.escapeSqlParameter = exports.SQLiteCloudConnection = exports.SQLiteCloudRow = exports.SQLiteCloudRowset = exports.SQLiteCloudError = exports.Statement = exports.Database = void 0;
-var database_1 = require("./database");
+exports.validateConfiguration = exports.parseConnectionString = exports.prepareSql = exports.escapeSqlParameter = exports.SQLiteCloudRow = exports.SQLiteCloudRowset = exports.SQLiteCloudError = exports.SQLiteCloudConnection = exports.Statement = exports.Database = void 0;
+// include ONLY packages used by drivers
+// do NOT include anything related to gateway or bun or express
+// connection-tls does not want/need to load on browser and is loaded dynamically by Database
+// connection-ws does not want/need to load on node and is loaded dynamically by Database
+var database_1 = require("./drivers/database");
 Object.defineProperty(exports, "Database", { enumerable: true, get: function () { return database_1.Database; } });
-var statement_1 = require("./statement");
+var statement_1 = require("./drivers/statement");
 Object.defineProperty(exports, "Statement", { enumerable: true, get: function () { return statement_1.Statement; } });
-var types_1 = require("./types");
+var connection_1 = require("./drivers/connection");
+Object.defineProperty(exports, "SQLiteCloudConnection", { enumerable: true, get: function () { return connection_1.SQLiteCloudConnection; } });
+var types_1 = require("./drivers/types");
 Object.defineProperty(exports, "SQLiteCloudError", { enumerable: true, get: function () { return types_1.SQLiteCloudError; } });
-var rowset_1 = require("./rowset");
+var rowset_1 = require("./drivers/rowset");
 Object.defineProperty(exports, "SQLiteCloudRowset", { enumerable: true, get: function () { return rowset_1.SQLiteCloudRowset; } });
 Object.defineProperty(exports, "SQLiteCloudRow", { enumerable: true, get: function () { return rowset_1.SQLiteCloudRow; } });
-var connection_1 = require("./connection");
-Object.defineProperty(exports, "SQLiteCloudConnection", { enumerable: true, get: function () { return connection_1.SQLiteCloudConnection; } });
-var utilities_1 = require("./utilities");
+var utilities_1 = require("./drivers/utilities");
 Object.defineProperty(exports, "escapeSqlParameter", { enumerable: true, get: function () { return utilities_1.escapeSqlParameter; } });
 Object.defineProperty(exports, "prepareSql", { enumerable: true, get: function () { return utilities_1.prepareSql; } });
 Object.defineProperty(exports, "parseConnectionString", { enumerable: true, get: function () { return utilities_1.parseConnectionString; } });
-var transport_ws_1 = require("./transport-ws");
-Object.defineProperty(exports, "WebSocketTransport", { enumerable: true, get: function () { return transport_ws_1.WebSocketTransport; } });
-var transport_tls_1 = require("./transport-tls");
-Object.defineProperty(exports, "TlsSocketTransport", { enumerable: true, get: function () { return transport_tls_1.TlsSocketTransport; } });
+Object.defineProperty(exports, "validateConfiguration", { enumerable: true, get: function () { return utilities_1.validateConfiguration; } });