@op-engineering/op-sqlite 15.0.7 → 15.1.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@op-engineering/op-sqlite",
-  "version": "15.0.7",
-  "description": "Next generation SQLite for React Native",
+  "version": "15.1.1",
+  "description": "Fastest SQLite for React Native",
   "main": "./lib/module/index.js",
   "types": "./lib/typescript/src/index.d.ts",
   "react-native": "src/index",
@@ -48,7 +48,7 @@
     "sqlite"
   ],
   "repository": "https://github.com/OP-Engineering/op-sqlite",
-  "author": "Oscar Franco <ospfranco@protonmail.com> (https://github.com/ospfranco)",
+  "author": "Oscar Franco <ospfranco@gmail.com> (https://github.com/ospfranco)",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/OP-Engineering/op-sqlite/issues"
@@ -59,11 +59,10 @@
   },
   "devDependencies": {
     "clang-format": "^1.8.0",
-    "lefthook": "^1.5.5",
     "react": "19.1.1",
-    "react-native": "0.81.0",
-    "react-native-builder-bob": "^0.40.13",
-    "typescript": "5.8.3"
+    "react-native": "0.82.1",
+    "react-native-builder-bob": "^0.40.15",
+    "typescript": "5.0.4"
   },
   "peerDependencies": {
     "react": "*",
@@ -110,5 +109,8 @@
     "type": "turbo-module",
     "version": "0.52.1"
   },
-  "packageManager": "yarn@4.3.1"
+  "packageManager": "yarn@4.11.0",
+  "dependencies": {
+    "react-native-safe-area-context": "^5.6.2"
+  }
 }

package/src/functions.ts

@@ -94,6 +94,18 @@ function enhanceDB(db: _InternalDB, options: DBParams): DB {
     delete: db.delete,
     attach: db.attach,
     detach: db.detach,
+    loadFile: db.loadFile,
+    updateHook: db.updateHook,
+    commitHook: db.commitHook,
+    rollbackHook: db.rollbackHook,
+    loadExtension: db.loadExtension,
+    getDbPath: db.getDbPath,
+    reactiveExecute: db.reactiveExecute,
+    sync: db.sync,
+    setReservedBytes: db.setReservedBytes,
+    getReservedBytes: db.getReservedBytes,
+    close: db.close,
+    flushPendingReactiveQueries: db.flushPendingReactiveQueries,
     executeBatch: async (
       commands: SQLBatchTuple[]
     ): Promise<BatchQueryResult> => {
@@ -141,17 +153,6 @@ function enhanceDB(db: _InternalDB, options: DBParams): DB {
         startNextTransaction();
       });
     },
-    loadFile: db.loadFile,
-    updateHook: db.updateHook,
-    commitHook: db.commitHook,
-    rollbackHook: db.rollbackHook,
-    loadExtension: db.loadExtension,
-    getDbPath: db.getDbPath,
-    reactiveExecute: db.reactiveExecute,
-    sync: db.sync,
-    setReservedBytes: db.setReservedBytes,
-    getReservedBytes: db.getReservedBytes,
-    close: db.close,
     executeWithHostObjects: async (
       query: string,
       params?: Scalar[]
@@ -180,31 +181,31 @@ function enhanceDB(db: _InternalDB, options: DBParams): DB {
       return db.executeRaw(query, sanitizedParams as Scalar[]);
     },
     executeSync: (query: string, params?: Scalar[]): QueryResult => {
-      const sanitizedParams = sanitizeArrayBuffersInArray(params);
-
-      let intermediateResult = sanitizedParams
-        ? db.executeSync(query, sanitizedParams as Scalar[])
+      let res = params
+        ? db.executeSync(query, sanitizeArrayBuffersInArray(params) as Scalar[])
         : db.executeSync(query);
 
-      let rows: Record<string, Scalar>[] = [];
-      for (let i = 0; i < (intermediateResult.rawRows?.length ?? 0); i++) {
-        let row: Record<string, Scalar> = {};
-        let rawRow = intermediateResult.rawRows![i]!;
-        for (let j = 0; j < intermediateResult.columnNames!.length; j++) {
-          let columnName = intermediateResult.columnNames![j]!;
-          let value = rawRow[j]!;
+      if (!res.rows) {
+        let rows: Record<string, Scalar>[] = [];
+        for (let i = 0; i < (res.rawRows?.length ?? 0); i++) {
+          let row: Record<string, Scalar> = {};
+          let rawRow = res.rawRows![i]!;
+          for (let j = 0; j < res.columnNames!.length; j++) {
+            let columnName = res.columnNames![j]!;
+            let value = rawRow[j]!;
 
-          row[columnName] = value;
+            row[columnName] = value;
+          }
+          rows.push(row);
         }
-        rows.push(row);
-      }
 
-      let res = {
-        ...intermediateResult,
-        rows,
-      };
+        delete res.rawRows;
 
-      delete res.rawRows;
+        res = {
+          ...res,
+          rows,
+        };
+      }
 
       return res;
     },
@@ -218,32 +219,34 @@ function enhanceDB(db: _InternalDB, options: DBParams): DB {
       query: string,
       params?: Scalar[] | undefined
     ): Promise<QueryResult> => {
-      const sanitizedParams = sanitizeArrayBuffersInArray(params);
-
-      let intermediateResult = await db.execute(
-        query,
-        sanitizedParams as Scalar[]
-      );
-
-      let rows: Record<string, Scalar>[] = [];
-      for (let i = 0; i < (intermediateResult.rawRows?.length ?? 0); i++) {
-        let row: Record<string, Scalar> = {};
-        let rawRow = intermediateResult.rawRows![i]!;
-        for (let j = 0; j < intermediateResult.columnNames!.length; j++) {
-          let columnName = intermediateResult.columnNames![j]!;
-          let value = rawRow[j]!;
-
-          row[columnName] = value;
+      let res = params
+        ? await db.execute(
+            query,
+            sanitizeArrayBuffersInArray(params) as Scalar[]
+          )
+        : await db.execute(query);
+
+      if (!res.rows) {
+        let rows: Record<string, Scalar>[] = [];
+        for (let i = 0; i < (res.rawRows?.length ?? 0); i++) {
+          let row: Record<string, Scalar> = {};
+          let rawRow = res.rawRows![i]!;
+          for (let j = 0; j < res.columnNames!.length; j++) {
+            let columnName = res.columnNames![j]!;
+            let value = rawRow[j]!;
+
+            row[columnName] = value;
+          }
+          rows.push(row);
         }
-        rows.push(row);
-      }
 
-      let res = {
-        ...intermediateResult,
-        rows,
-      };
+        delete res.rawRows;
 
-      delete res.rawRows;
+        res = {
+          ...res,
+          rows,
+        };
+      }
 
       return res;
     },
@@ -416,11 +419,18 @@ export const open = (params: {
   return enhancedDb;
 };
 
+export function openV2(params: { path: string; encryptionKey?: string }) {
+  const db = OPSQLite.openV2(params);
+  const enhancedDb = enhanceDB(db, params as any);
+
+  return enhancedDb;
+}
+
 /**
  * Moves the database from the assets folder to the default path (check the docs) or to a custom path
  * It DOES NOT OVERWRITE the database if it already exists in the destination path
  * if you want to overwrite the database, you need to pass the overwrite flag as true
- * @param args object with the parameters for the operaiton
+ * @param args object with the parameters for the operation
  * @returns promise, rejects if failed to move the database, resolves if the operation was successful
  */
 export const moveAssetsDatabase = async (args: {

package/src/index.ts

@@ -1,17 +1,6 @@
 import { NativeModules } from 'react-native';
 
-export {
-  OPSQLite,
-  open,
-  openRemote,
-  openSync,
-  moveAssetsDatabase,
-  getDylibPath,
-  isSQLCipher,
-  isLibsql,
-  isIOSEmbedded,
-  isIOSEmbeeded,
-} from './functions';
+export * from './functions';
 export { Storage } from './Storage';
 export type {
   Scalar,

package/src/types.ts

@@ -269,7 +269,7 @@ export type DB = {
    */
   executeRawSync: (query: string, params?: Scalar[]) => any[];
   /**
-   * Get's the absolute path to the db file. Useful for debugging on local builds and for attaching the DB from users devices
+   * Gets the absolute path to the db file. Useful for debugging on local builds and for attaching the DB from users devices
    */
   getDbPath: (location?: string) => string;
   /**
@@ -294,6 +294,13 @@ export type DB = {
   sync: () => void;
   setReservedBytes: (reservedBytes: number) => void;
   getReservedBytes: () => number;
+  /**
+   * If you have changed any of the tables outside of a transaction then the reactive queries will not fire on their own
+   * This method allows to flush the pending queue of changes. Useful when using Drizzle or other ORM that do not
+   * use the db.transaction method internally
+   * @returns void
+   */
+  flushPendingReactiveQueries: () => Promise<void>;
 };
 
 export type DBParams = {
@@ -310,6 +317,7 @@ export type OPSQLiteProxy = {
     location?: string;
     encryptionKey?: string;
   }) => _InternalDB;
+  openV2: (options: { path: string; encryptionKey?: string }) => _InternalDB;
   openRemote: (options: { url: string; authToken: string }) => _InternalDB;
   openSync: (options: DBParams) => _InternalDB;
   isSQLCipher: () => boolean;

package/cpp/bindings.cpp

@@ -1,202 +0,0 @@
-#include "bindings.h"
-#include "DBHostObject.h"
-#include "DumbHostObject.h"
-#include "OPThreadPool.h"
-#ifdef OP_SQLITE_USE_LIBSQL
-#include "libsql/bridge.h"
-#else
-#include "bridge.h"
-#endif
-#include "logs.h"
-#include "macros.h"
-#include "utils.h"
-#include <iostream>
-#include <string>
-#include <unordered_map>
-#include <vector>
-
-namespace opsqlite {
-
-namespace jsi = facebook::jsi;
-
-std::string _base_path;
-std::string _crsqlite_path;
-std::string _sqlite_vec_path;
-std::vector<std::shared_ptr<DBHostObject>> dbs;
-
-// React native will try to clean the module on JS context invalidation
-// (CodePush/Hot Reload) The clearState function is called
-void invalidate() {
-    for (const auto &db : dbs) {
-        db->invalidate();
-    }
-
-    // Clear our existing vector of shared pointers so they can be garbage
-    // collected
-    dbs.clear();
-}
-
-void install(jsi::Runtime &rt,
-             const std::shared_ptr<react::CallInvoker> &invoker,
-             const char *base_path, const char *crsqlite_path,
-             const char *sqlite_vec_path) {
-    _base_path = std::string(base_path);
-    _crsqlite_path = std::string(crsqlite_path);
-    _sqlite_vec_path = std::string(sqlite_vec_path);
-
-    auto open = HOST_STATIC_FN("open") {
-        jsi::Object options = args[0].asObject(rt);
-        std::string name =
-            options.getProperty(rt, "name").asString(rt).utf8(rt);
-        std::string path = std::string(_base_path);
-        std::string location;
-        std::string encryption_key;
-
-        if (options.hasProperty(rt, "location")) {
-            location =
-                options.getProperty(rt, "location").asString(rt).utf8(rt);
-        }
-
-        if (options.hasProperty(rt, "encryptionKey")) {
-            encryption_key =
-                options.getProperty(rt, "encryptionKey").asString(rt).utf8(rt);
-        }
-
-#ifdef OP_SQLITE_USE_SQLCIPHER
-        if (encryption_key.empty()) {
-            log_to_console(rt, "Encryption key is missing for SQLCipher");
-        }
-#endif
-
-        if (!location.empty()) {
-            if (location == ":memory:") {
-                path = ":memory:";
-            } else if (location.rfind('/', 0) == 0) {
-                path = location;
-            } else {
-                path = path + "/" + location;
-            }
-        }
-
-        std::shared_ptr<DBHostObject> db = std::make_shared<DBHostObject>(
-            rt, path, invoker, name, path, _crsqlite_path, _sqlite_vec_path,
-            encryption_key);
-        dbs.emplace_back(db);
-        return jsi::Object::createFromHostObject(rt, db);
-    });
-
-    auto is_sqlcipher = HOST_STATIC_FN("isSQLCipher") {
-#ifdef OP_SQLITE_USE_SQLCIPHER
-        return true;
-#else
-        return false;
-#endif
-    });
-
-    auto is_ios_embedded = HOST_STATIC_FN("isIOSEmbedded") {
-#ifdef OP_SQLITE_USE_PHONE_VERSION
-        return true;
-#else
-        return false;
-#endif
-    });
-
-    auto is_libsql = HOST_STATIC_FN("isLibsql") {
-#ifdef OP_SQLITE_USE_LIBSQL
-        return true;
-#else
-        return false;
-#endif
-    });
-
-#ifdef OP_SQLITE_USE_LIBSQL
-    auto open_remote = HOST_STATIC_FN("openRemote") {
-        jsi::Object options = args[0].asObject(rt);
-      
-        std::string url = options.getProperty(rt, "url").asString(rt).utf8(rt);
-      
-        std::string auth_token =
-            options.getProperty(rt, "authToken").asString(rt).utf8(rt);
-      
-        std::shared_ptr<DBHostObject> db = std::make_shared<DBHostObject>(
-            rt, url, auth_token, invoker);
-      
-        return jsi::Object::createFromHostObject(rt, db);
-    });
-
-    auto open_sync = HOST_STATIC_FN("openSync") {
-        jsi::Object options = args[0].asObject(rt);
-        std::string name =
-            options.getProperty(rt, "name").asString(rt).utf8(rt);
-        std::string path = std::string(_base_path);
-        std::string url = options.getProperty(rt, "url").asString(rt).utf8(rt);
-        std::string auth_token =
-            options.getProperty(rt, "authToken").asString(rt).utf8(rt);
-
-        int sync_interval = 0;
-        if (options.hasProperty(rt, "libsqlSyncInterval")) {
-            sync_interval = static_cast<int>(
-                options.getProperty(rt, "libsqlSyncInterval").asNumber());
-        }
-
-        bool offline = false;
-        if (options.hasProperty(rt, "libsqlOffline")) {
-            offline = options.getProperty(rt, "libsqlOffline").asBool();
-        }
-
-        std::string encryption_key;
-        if (options.hasProperty(rt, "encryptionKey")) {
-            encryption_key =
-                options.getProperty(rt, "encryptionKey").asString(rt).utf8(rt);
-        }
-
-        std::string remote_encryption_key;
-        if (options.hasProperty(rt, "remoteEncryptionKey")) {
-            remote_encryption_key =
-                options.getProperty(rt, "remoteEncryptionKey").asString(rt).utf8(rt);
-        }
-
-        std::string location;
-        if (options.hasProperty(rt, "location")) {
-            location =
-                options.getProperty(rt, "location").asString(rt).utf8(rt);
-        }
-        if (!location.empty()) {
-            if (location == ":memory:") {
-                path = ":memory:";
-            } else if (location.rfind("/", 0) == 0) {
-                path = location;
-            } else {
-                path = path + "/" + location;
-            }
-        }
-
-        std::shared_ptr<DBHostObject> db = std::make_shared<DBHostObject>(
-            rt, invoker, name, path, url, auth_token, sync_interval, offline, encryption_key, remote_encryption_key);
-        return jsi::Object::createFromHostObject(rt, db);
-    });
-#endif
-
-    jsi::Object module = jsi::Object(rt);
-    module.setProperty(rt, "open", std::move(open));
-    module.setProperty(rt, "isSQLCipher", std::move(is_sqlcipher));
-    module.setProperty(rt, "isLibsql", std::move(is_libsql));
-    module.setProperty(rt, "isIOSEmbedded", std::move(is_ios_embedded));
-#ifdef OP_SQLITE_USE_LIBSQL
-    module.setProperty(rt, "openRemote", std::move(open_remote));
-    module.setProperty(rt, "openSync", std::move(open_sync));
-#endif
-
-    rt.global().setProperty(rt, "__OPSQLiteProxy", std::move(module));
-}
-
-void expoUpdatesWorkaround(const char *base_path) {
-#ifdef OP_SQLITE_USE_LIBSQL
-    std::string path = std::string(base_path);
-    // Open a DB before anything else so that expo-updates does not mess up the
-    // configuration
-    opsqlite_libsql_open("__dummy", path, "");
-#endif
-}
-
-} // namespace opsqlite

package/cpp/macros.h

@@ -1,15 +0,0 @@
-#pragma once
-
-#define HOSTFN(name)                                                           \
-jsi::Function::createFromHostFunction( \
-rt, \
-jsi::PropNameID::forAscii(rt, name), \
-0, \
-[=, this](jsi::Runtime &rt, const jsi::Value &thisValue, const jsi::Value *args, size_t count) -> jsi::Value
-
-#define HOST_STATIC_FN(name)                                                   \
-jsi::Function::createFromHostFunction( \
-rt, \
-jsi::PropNameID::forAscii(rt, name), \
-0, \
-[=](jsi::Runtime &rt, const jsi::Value &thisValue, const jsi::Value *args, size_t count) -> jsi::Value

package/cpp/types.h

@@ -1,33 +0,0 @@
-#pragma once
-
-#include <memory>
-#include <string>
-#include <variant>
-#include <vector>
-
-struct ArrayBuffer {
-    std::shared_ptr<uint8_t> data;
-    size_t size;
-};
-
-using JSVariant = std::variant<nullptr_t, bool, int, double, long, long long,
-                               std::string, ArrayBuffer>;
-
-struct BridgeResult {
-    std::string message;
-    int affectedRows;
-    double insertId;
-    std::vector<std::vector<JSVariant>> rows;
-    std::vector<std::string> column_names;
-};
-
-struct BatchResult {
-    std::string message;
-    int affectedRows;
-    int commands;
-};
-
-struct BatchArguments {
-    std::string sql;
-    std::vector<JSVariant> params;
-};