@sqlitecloud/drivers 1.0.245 → 1.0.256-rc.1

package/README.md

@@ -12,6 +12,38 @@
 npm install @sqlitecloud/drivers
 ```
 
+## React Native / Expo Install
+
+You also have to install Peer Dependencies
+
+```bash
+npm install @sqlitecloud/drivers react-native-tcp-socket react-native-fast-base64
+```
+
+React Native run IOS
+
+```bash
+cd ios && pod install && cd .. && npm run ios
+```
+
+React Native run Android (without ./ in Windows)
+
+```bash
+cd android && ./gradlew clean build && cd .. && npm run android
+```
+
+Expo run IOS
+
+```bash
+npx expo prebuild && npx expo run:ios
+```
+
+Expo run Android
+
+```bash
+npx expo prebuild && npx expo run:android
+```
+
 ## Usage
 
 ```ts
@@ -60,6 +92,10 @@ Pub/Sub is a messaging pattern that allows multiple applications to communicate
 
 Pub/Sub Documentation: [https://docs.sqlitecloud.io/docs/pub-sub](https://docs.sqlitecloud.io/docs/pub-sub)
 
+## Examples
+
+Check out all the supported platforms with related examples [here](https://github.com/sqlitecloud/sqlitecloud-js/tree/main/examples)!
+
 ## More
 
 How do I deploy SQLite in the cloud?  

package/lib/drivers/connection-tls.js

@@ -31,6 +31,8 @@ const types_1 = require("./types");
 const connection_1 = require("./connection");
 const utilities_1 = require("./utilities");
 const protocol_1 = require("./protocol");
+// explicitly importing buffer library to allow cross-platform support by replacing it
+const buffer_1 = require("buffer");
 const tls = __importStar(require("tls"));
 /**
  * Implementation of SQLiteCloudConnection that connects to the database using specific tls APIs
@@ -43,7 +45,7 @@ class SQLiteCloudTlsConnection extends connection_1.SQLiteCloudConnection {
         // onData is called when data is received, it will process the data until all data is retrieved for a response
         // when response is complete or there's an error, finish is called to call the results callback set by processCommands...
         // buffer to accumulate incoming data until an whole command is received and can be parsed
-        this.buffer = Buffer.alloc(0);
+        this.buffer = buffer_1.Buffer.alloc(0);
         this.startedOn = new Date();
         this.pendingChunks = [];
     }
@@ -71,7 +73,14 @@ class SQLiteCloudTlsConnection extends connection_1.SQLiteCloudConnection {
             // https://r2.nodejs.org/docs/v6.11.4/api/tls.html#tls_class_tls_tlssocket
             servername: config.host
         };
-        this.socket = tls.connect(connectionOptions, () => {
+        // tls.connect in the react-native-tcp-socket library is tls.connectTLS
+        let connector = tls.connect;
+        // @ts-ignore
+        if (typeof tls.connectTLS !== 'undefined') {
+            // @ts-ignore
+            connector = tls.connectTLS;
+        }
+        this.socket = connector(connectionOptions, () => {
             var _a;
             if (this.config.verbose) {
                 console.debug(`SQLiteCloudTlsConnection - connected to ${this.config.host}, authorized: ${(_a = this.socket) === null || _a === void 0 ? void 0 : _a.authorized}`);
@@ -110,7 +119,7 @@ class SQLiteCloudTlsConnection extends connection_1.SQLiteCloudConnection {
             return this;
         }
         // reset buffer and rowset chunks, define response callback
-        this.buffer = Buffer.alloc(0);
+        this.buffer = buffer_1.Buffer.alloc(0);
         this.startedOn = new Date();
         this.processCallback = callback;
         this.executingCommands = commands;
@@ -143,7 +152,7 @@ class SQLiteCloudTlsConnection extends connection_1.SQLiteCloudConnection {
             // append data to buffer as it arrives
             if (data.length && data.length > 0) {
                 // console.debug(`processCommandsData - received ${data.length} bytes`)
-                this.buffer = Buffer.concat([this.buffer, data]);
+                this.buffer = buffer_1.Buffer.concat([this.buffer, data]);
             }
             let dataType = (_a = this.buffer) === null || _a === void 0 ? void 0 : _a.subarray(0, 1).toString();
             if ((0, protocol_1.hasCommandLength)(dataType)) {
@@ -164,7 +173,7 @@ class SQLiteCloudTlsConnection extends connection_1.SQLiteCloudConnection {
                         if (decompressResults.dataType === protocol_1.CMD_ROWSET_CHUNK) {
                             this.pendingChunks.push(decompressResults.buffer);
                             this.buffer = decompressResults.remainingBuffer;
-                            this.processCommandsData(Buffer.alloc(0));
+                            this.processCommandsData(buffer_1.Buffer.alloc(0));
                             return;
                         }
                         else {
@@ -217,7 +226,7 @@ class SQLiteCloudTlsConnection extends connection_1.SQLiteCloudConnection {
         if (this.processCallback) {
             this.processCallback(error, result);
         }
-        this.buffer = Buffer.alloc(0);
+        this.buffer = buffer_1.Buffer.alloc(0);
         this.pendingChunks = [];
     }
     /** Disconnect immediately, release connection, no events. */

package/lib/drivers/protocol.js

@@ -6,6 +6,8 @@ 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_PUBSUB = 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");
+// explicitly importing buffer library to allow cross-platform support by replacing it
+const buffer_1 = require("buffer");
 // https://www.npmjs.com/package/lz4js
 const lz4 = require('lz4js');
 // The server communicates with clients via commands defined in
@@ -59,13 +61,13 @@ function decompressBuffer(buffer) {
     commandBuffer = commandBuffer.subarray(commandBuffer.indexOf(' ') + 1);
     // extract compressed dataType
     const dataType = commandBuffer.subarray(0, 1).toString('utf8');
-    let decompressedBuffer = Buffer.alloc(decompressedSize);
+    let decompressedBuffer = buffer_1.Buffer.alloc(decompressedSize);
     const compressedBuffer = commandBuffer.subarray(commandBuffer.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);
     // the entire command is composed of the header (which is not compressed) + the decompressed block
-    decompressedBuffer = Buffer.concat([commandBuffer.subarray(0, commandBuffer.length - compressedSize), decompressedBuffer]);
+    decompressedBuffer = buffer_1.Buffer.concat([commandBuffer.subarray(0, commandBuffer.length - compressedSize), decompressedBuffer]);
     if (decompressionResult <= 0 || decompressionResult !== decompressedSize) {
         throw new Error(`lz4 decompression error at offset ${decompressionResult}`);
     }
@@ -195,7 +197,7 @@ exports.bufferEndsWith = bufferEndsWith;
  * @see https://github.com/sqlitecloud/sdk/blob/master/PROTOCOL.md#scsp-rowset-chunk
  */
 function parseRowsetChunks(buffers) {
-    let buffer = Buffer.concat(buffers);
+    let buffer = buffer_1.Buffer.concat(buffers);
     if (!bufferStartsWith(buffer, exports.CMD_ROWSET_CHUNK) || !bufferEndsWith(buffer, exports.ROWSET_CHUNKS_END)) {
         throw new Error('SQLiteCloudConnection.parseRowsetChunks - invalid chunks buffer');
     }
@@ -248,7 +250,7 @@ function popData(buffer) {
         return { data, fwdBuffer };
     }
     // first character is the data type
-    console.assert(buffer && buffer instanceof Buffer);
+    console.assert(buffer && buffer instanceof buffer_1.Buffer);
     let dataType = buffer.subarray(0, 1).toString('utf8');
     if (dataType == exports.CMD_COMPRESSED)
         throw new Error('Compressed data should be decompressed before parsing');
@@ -301,7 +303,7 @@ function popData(buffer) {
 exports.popData = popData;
 /** Format a command to be sent via SCSP protocol */
 function formatCommand(command) {
-    const commandLength = Buffer.byteLength(command, 'utf-8');
+    const commandLength = buffer_1.Buffer.byteLength(command, 'utf-8');
     return `+${commandLength} ${command}`;
 }
 exports.formatCommand = formatCommand;

package/lib/drivers/utilities.js

@@ -6,7 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseBooleanToZeroOne = exports.parseBoolean = exports.parseconnectionstring = exports.validateConfiguration = exports.popCallback = exports.getUpdateResults = exports.prepareSql = exports.escapeSqlParameter = exports.getInitializationCommands = exports.anonimizeError = exports.anonimizeCommand = exports.isNode = exports.isBrowser = void 0;
 const types_1 = require("./types");
 const types_2 = require("./types");
+// explicitly importing these libraries to allow cross-platform support by replacing them
 const whatwg_url_1 = require("whatwg-url");
+const buffer_1 = require("buffer");
 //
 // determining running environment, thanks to browser-or-node
 // https://www.npmjs.com/package/browser-or-node
@@ -94,7 +96,7 @@ function escapeSqlParameter(param) {
         return param ? '1' : '0';
     }
     // serialize buffer as X'...' hex encoded string
-    if (Buffer.isBuffer(param)) {
+    if (buffer_1.Buffer.isBuffer(param)) {
         return `X'${param.toString('hex')}'`;
     }
     if (typeof param === 'object') {
@@ -118,7 +120,7 @@ function prepareSql(sql, ...params) {
         const index = matchIndex ? parseInt(matchIndex) : parameterIndex;
         parameterIndex++;
         let sqlParameter;
-        if (params[0] && typeof params[0] === 'object' && !(params[0] instanceof Buffer)) {
+        if (params[0] && typeof params[0] === 'object' && !(params[0] instanceof buffer_1.Buffer)) {
             sqlParameter = params[0][index];
         }
         if (!sqlParameter) {