feat: Add null/undefined support (#109)

* feat: add null support in JS and update types

* chore: update nitrogen specs

* fix: rename null type

* fix: missing nitrogen file

* feat: add null support in cpp code

* feat: add ENABLE_SIMPLE_NULL_HANDLING flag

* chore: update nitro specs

* fix: rename types

* refactor: rename simple null handling functions

* fix: check for null struct in buildQueryResult

* test: add unit tests for passing and receiving null values

* feat: improve NITRO_SQLITE_NULL handling

Author: chrispader

example/src/tests/unitTests.spec.ts

@@ -1,7 +1,9 @@
 import Chance from 'chance'
-import type {
-  NitroSQLiteConnection,
-  BatchQueryCommand,
+import {
+  type NitroSQLiteConnection,
+  type BatchQueryCommand,
+  NITRO_SQLITE_NULL,
+  enableSimpleNullHandling,
 } from 'react-native-nitro-sqlite'
 import { beforeEach, describe, it } from './MochaRNAdapter'
 import chai from 'chai'
@@ -19,6 +21,8 @@ export function registerUnitTests() {
   let testDb: NitroSQLiteConnection
 
   beforeEach(() => {
+    enableSimpleNullHandling(false)
+
     try {
       resetTestDb()
 
@@ -54,6 +58,62 @@ export function registerUnitTests() {
       expect(res.rows?.item).to.be.a('function')
     })
 
+    it('Insert with null', () => {
+      const id = chance.integer()
+      const name = chance.name()
+      const age = NITRO_SQLITE_NULL
+      const networth = NITRO_SQLITE_NULL
+      const res = testDb.execute(
+        'INSERT INTO "User" (id, name, age, networth) VALUES(?, ?, ?, ?)',
+        [id, name, age, networth]
+      )
+
+      expect(res.rowsAffected).to.equal(1)
+      expect(res.insertId).to.equal(1)
+      expect(res.rows?._array).to.eql([])
+      expect(res.rows?.length).to.equal(0)
+      expect(res.rows?.item).to.be.a('function')
+
+      const selectRes = testDb.execute('SELECT * FROM User')
+      expect(selectRes.rows?._array).to.eql([
+        {
+          id,
+          name,
+          age,
+          networth,
+        },
+      ])
+    })
+
+    it('Insert with null (simple null handling)', () => {
+      enableSimpleNullHandling(true)
+
+      const id = chance.integer()
+      const name = chance.name()
+      const age = undefined
+      const networth = null
+      const res = testDb.execute(
+        'INSERT INTO "User" (id, name, age, networth) VALUES(?, ?, ?, ?)',
+        [id, name, age, networth]
+      )
+
+      expect(res.rowsAffected).to.equal(1)
+      expect(res.insertId).to.equal(1)
+      expect(res.rows?._array).to.eql([])
+      expect(res.rows?.length).to.equal(0)
+      expect(res.rows?.item).to.be.a('function')
+
+      const selectRes = testDb.execute('SELECT * FROM User')
+      expect(selectRes.rows?._array).to.eql([
+        {
+          id,
+          name,
+          age: null,
+          networth: null,
+        },
+      ])
+    })
+
     it('Query without params', () => {
       const id = chance.integer()
       const name = chance.name()

package/cpp/operations.cpp

@@ -102,16 +102,12 @@ void bindStatement(sqlite3_stmt* statement, const SQLiteQueryParams& values) {
   for (int valueIndex = 0; valueIndex < values.size(); valueIndex++) {
     int sqliteIndex = valueIndex+1;
     SQLiteValue value = values.at(valueIndex);
-    // if (std::holds_alternative<std::monostate>(value))
-    // {
-    //     sqlite3_bind_null(statement, sqliteIndex);
-    // }
-    if (std::holds_alternative<bool>(value)) {
+    if (std::holds_alternative<SQLiteNullValue>(value)) {
+      sqlite3_bind_null(statement, sqliteIndex);
+    } else if (std::holds_alternative<bool>(value)) {
       sqlite3_bind_int(statement, sqliteIndex, std::get<bool>(value));
     } else if (std::holds_alternative<double>(value)) {
       sqlite3_bind_double(statement, sqliteIndex, std::get<double>(value));
-    } else if (std::holds_alternative<int64_t>(value)) {
-      sqlite3_bind_int64(statement, sqliteIndex, std::get<int64_t>(value));
     } else if (std::holds_alternative<std::string>(value)) {
       const auto stringValue = std::get<std::string>(value);
       sqlite3_bind_text(statement, sqliteIndex, stringValue.c_str(), stringValue.length(), SQLITE_TRANSIENT);
@@ -191,7 +187,7 @@ SQLiteExecuteQueryResult sqliteExecute(const std::string& dbName, const std::str
             case SQLITE_NULL:
               // Intentionally left blank to switch to default case
             default:
-              //                            row[column_name] = std::monostate();
+              row[column_name] = SQLiteNullValue(true);
               break;
           }
           i++;

package/cpp/types.hpp

@@ -1,17 +1,17 @@
 #pragma once
 
+#include <string>
+#include <NitroModules/ArrayBuffer.hpp>
 #include "SQLiteQueryColumnMetadata.hpp"
 #include "ColumnType.hpp"
-#include <NitroModules/ArrayBuffer.hpp>
-#include <string>
+#include "SQLiteNullValue.hpp"
 
 using namespace margelo::nitro;
 using namespace margelo::nitro::rnnitrosqlite;
 
 namespace margelo::rnnitrosqlite {
 
-// using SQLiteValue = std::variant<std::string, double, int64_t, bool, std::shared_ptr<ArrayBuffer>, std::monostate>;
-using SQLiteValue = std::variant<std::string, double, int64_t, bool, std::shared_ptr<ArrayBuffer>>;
+using SQLiteValue = std::variant<std::string, double, bool, std::shared_ptr<ArrayBuffer>, SQLiteNullValue>;
 using SQLiteQueryParams = std::vector<SQLiteValue>;
 using SQLiteQueryResultRow = std::unordered_map<std::string, SQLiteValue>;
 using SQLiteQueryResults = std::vector<SQLiteQueryResultRow>;

package/nitrogen/generated/android/RNNitroSQLite+autolinking.cmake

@@ -2,7 +2,7 @@
 # RNNitroSQLite+autolinking.cmake
 # This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
 # https://github.com/mrousavy/nitro
-# Copyright © 2024 Marc Rousavy @ Margelo
+# Copyright © 2025 Marc Rousavy @ Margelo
 #
 
 # This is a CMake file that adds all files generated by Nitrogen

package/nitrogen/generated/android/RNNitroSQLite+autolinking.gradle

@@ -2,7 +2,7 @@
 /// RNNitroSQLite+autolinking.gradle
 /// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
 /// https://github.com/mrousavy/nitro
-/// Copyright © 2024 Marc Rousavy @ Margelo
+/// Copyright © 2025 Marc Rousavy @ Margelo
 ///
 
 /// This is a Gradle file that adds all files generated by Nitrogen

package/nitrogen/generated/android/RNNitroSQLiteOnLoad.cpp

@@ -2,7 +2,7 @@
 /// RNNitroSQLiteOnLoad.cpp
 /// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
 /// https://github.com/mrousavy/nitro
-/// Copyright © 2024 Marc Rousavy @ Margelo
+/// Copyright © 2025 Marc Rousavy @ Margelo
 ///
 
 #include "RNNitroSQLiteOnLoad.hpp"

package/nitrogen/generated/android/RNNitroSQLiteOnLoad.hpp

@@ -2,7 +2,7 @@
 /// RNNitroSQLiteOnLoad.hpp
 /// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
 /// https://github.com/mrousavy/nitro
-/// Copyright © 2024 Marc Rousavy @ Margelo
+/// Copyright © 2025 Marc Rousavy @ Margelo
 ///
 
 #include <jni.h>

package/nitrogen/generated/ios/RNNitroSQLite+autolinking.rb

@@ -2,7 +2,7 @@
 # RNNitroSQLite+autolinking.rb
 # This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
 # https://github.com/mrousavy/nitro
-# Copyright © 2024 Marc Rousavy @ Margelo
+# Copyright © 2025 Marc Rousavy @ Margelo
 #
 
 # This is a Ruby script that adds all files generated by Nitrogen

package/nitrogen/generated/ios/RNNitroSQLite-Swift-Cxx-Bridge.cpp

@@ -2,7 +2,7 @@
 /// RNNitroSQLite-Swift-Cxx-Bridge.cpp
 /// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
 /// https://github.com/mrousavy/nitro
-/// Copyright © 2024 Marc Rousavy @ Margelo
+/// Copyright © 2025 Marc Rousavy @ Margelo
 ///
 
 #include "RNNitroSQLite-Swift-Cxx-Bridge.hpp"

package/nitrogen/generated/ios/RNNitroSQLite-Swift-Cxx-Bridge.hpp

@@ -2,7 +2,7 @@
 /// RNNitroSQLite-Swift-Cxx-Bridge.hpp
 /// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
 /// https://github.com/mrousavy/nitro
-/// Copyright © 2024 Marc Rousavy @ Margelo
+/// Copyright © 2025 Marc Rousavy @ Margelo
 ///
 
 #pragma once