feat: add ENABLE_SIMPLE_NULL_HANDLING flag

Author: chrispader

package/src/index.ts

@@ -7,8 +7,6 @@ import { NativeSQLiteNullValue } from './types'
 export type * from './types'
 export { typeORMDriver } from './typeORM'
 
-export const NITRO_SQLITE_NULL: NativeSQLiteNullValue = { isNull: true }
-
 export const onInitialized = new Promise<void>((resolve) => {
   NitroSQLiteOnLoad.onReactApplicationContextReady(resolve)
 })
@@ -27,3 +25,15 @@ export const NitroSQLite = {
 }
 
 export { open } from './operations/session'
+
+let ENABLE_SIMPLE_NULL_HANDLING = false
+export function enableEasierNullHandling(
+  shouldEnableSimpleNullHandling = true
+) {
+  ENABLE_SIMPLE_NULL_HANDLING = shouldEnableSimpleNullHandling
+}
+export function simpleNullHandlingEnabled() {
+  return ENABLE_SIMPLE_NULL_HANDLING
+}
+
+export const NITRO_SQLITE_NULL: NativeSQLiteNullValue = { isNull: true }

package/src/operations/execute.ts

@@ -1,4 +1,4 @@
-import { NITRO_SQLITE_NULL } from '..'
+import { NITRO_SQLITE_NULL, simpleNullHandlingEnabled } from '..'
 import { HybridNitroSQLite } from '../nitro'
 import type { NativeQueryResult } from '../specs/NativeQueryResult.nitro'
 import type {
@@ -8,31 +8,35 @@ import type {
   QueryResultRow,
 } from '../types'
 
-export function execute<Data extends QueryResultRow = never>(
+export function execute<Row extends QueryResultRow = never>(
   dbName: string,
   query: string,
   params?: SQLiteQueryParams
-): QueryResult<Data> {
+): QueryResult<Row> {
   const nativeResult = HybridNitroSQLite.execute(
     dbName,
     query,
     toNativeQueryParams(params)
   )
-  const result = buildJsQueryResult<Data>(nativeResult)
+  const result = buildJsQueryResult<Row>(nativeResult)
   return result
 }
 
-export async function executeAsync<Data extends QueryResultRow = never>(
+export async function executeAsync<Row extends QueryResultRow = never>(
   dbName: string,
   query: string,
   params?: SQLiteQueryParams
-): Promise<QueryResult<Data>> {
+): Promise<QueryResult<Row>> {
+  const transformedParams = simpleNullHandlingEnabled()
+    ? toNativeQueryParams(params)
+    : (params as NativeSQLiteQueryParams)
+
   const nativeResult = await HybridNitroSQLite.executeAsync(
     dbName,
     query,
-    toNativeQueryParams(params)
+    transformedParams
   )
-  const result = buildJsQueryResult<Data>(nativeResult)
+  const result = buildJsQueryResult<Row>(nativeResult)
   return result
 }
 
@@ -47,21 +51,25 @@ function toNativeQueryParams(
   })
 }
 
-function buildJsQueryResult<Data extends QueryResultRow = never>({
+function buildJsQueryResult<Row extends QueryResultRow = never>({
   insertId,
   rowsAffected,
   results,
-}: NativeQueryResult): QueryResult<Data> {
-  const data = results.map((row) =>
-    Object.fromEntries(
-      Object.entries(row).map(([key, value]) => {
-        if (value === NITRO_SQLITE_NULL) {
-          return [key, undefined]
-        }
-        return [key, value]
-      })
-    )
-  ) as Data[]
+}: NativeQueryResult): QueryResult<Row> {
+  let data: Row[] = results as Row[]
+
+  if (simpleNullHandlingEnabled()) {
+    data = results.map((row) =>
+      Object.fromEntries(
+        Object.entries(row).map(([key, value]) => {
+          if (value === NITRO_SQLITE_NULL) {
+            return [key, undefined]
+          }
+          return [key, value]
+        })
+      )
+    ) as Row[]
+  }
 
   return {
     insertId,

package/src/types.ts

@@ -26,22 +26,25 @@ export enum ColumnType {
   NULL_VALUE,
 }
 
-export type BaseSQLiteValue = boolean | number | string | ArrayBuffer
-
 // Passing null/undefined in array types is not possible, so we us a special struct as a workaround.
 export type NativeSQLiteNullValue = {
   isNull: true
 }
-export type NativeSQLiteValue = BaseSQLiteValue | NativeSQLiteNullValue
+export type NativeSQLiteValue =
+  | boolean
+  | number
+  | string
+  | ArrayBuffer
+  | NativeSQLiteNullValue
 export type NativeSQLiteQueryParams = NativeSQLiteValue[]
 
 /**
  * Represents a value that can be stored in a SQLite database
  */
-export type SQLiteValue = BaseSQLiteValue | null | undefined
+export type SQLiteValue = NativeSQLiteValue | null | undefined
 export type SQLiteQueryParams = SQLiteValue[]
 
-export type QueryResultItem = BaseSQLiteValue | undefined
+export type QueryResultItem = NativeSQLiteValue | undefined
 export type QueryResultRow = Record<string, QueryResultItem>
 export interface QueryResult<RowData extends QueryResultRow = QueryResultRow> {
   readonly insertId?: number