expo-sqlite 11.3.0 → 11.3.2

package/CHANGELOG.md

@@ -10,6 +10,19 @@
 
 ### 💡 Others
 
+## 11.3.2 — 2023-07-29
+
+### 🐛 Bug fixes
+
+- Fixed missing `transaction()` and `readTransaction()` function types from `SQLiteDatabase`. ([#23751](https://github.com/expo/expo/pull/23751) by [@kudo](https://github.com/kudo))
+
+## 11.3.1 — 2023-06-28
+
+### 🎉 New features
+
+- Migrated Android codebase to Expo Modules API. ([#23115](https://github.com/expo/expo/pull/23115) by [@alanjhughes](https://github.com/alanjhughes))
+- Added experimental `Promise` based `execAsync` and `transactionAsync` functions. ([#23109](https://github.com/expo/expo/pull/23109) by [@kudo](https://github.com/kudo))
+
 ## 11.3.0 — 2023-06-21
 
 ### 🐛 Bug fixes

package/android/build.gradle

@@ -3,7 +3,7 @@ apply plugin: 'kotlin-android'
 apply plugin: 'maven-publish'
 
 group = 'host.exp.exponent'
-version = '11.3.0'
+version = '11.3.2'
 
 buildscript {
   def expoModulesCorePlugin = new File(project(":expo-modules-core").projectDir.absolutePath, "ExpoModulesCorePlugin.gradle")
@@ -67,7 +67,7 @@ android {
     minSdkVersion safeExtGet("minSdkVersion", 21)
     targetSdkVersion safeExtGet("targetSdkVersion", 33)
     versionCode 18
-    versionName "11.3.0"
+    versionName "11.3.2"
   }
   lintOptions {
     abortOnError false

package/android/src/main/java/expo/modules/sqlite/SQLExceptions.kt

@@ -0,0 +1,15 @@
+package expo.modules.sqlite
+
+import expo.modules.kotlin.exception.CodedException
+
+class OpenDatabaseException(name: String) :
+  CodedException("Unable to delete database '$name' that is currently open. Close it prior to deletion.")
+
+class DatabaseNotFoundException(name: String) :
+  CodedException("Database '$name' not found")
+
+class DeleteDatabaseException(name: String) :
+  CodedException("Unable to delete the database file for '$name' database")
+
+class SQLiteException(message: String?, cause: Throwable?) :
+  CodedException(SQLiteModule::class.java.simpleName, message, cause)

package/android/src/main/java/expo/modules/sqlite/SQLRecords.kt

@@ -0,0 +1,11 @@
+package expo.modules.sqlite
+
+import expo.modules.kotlin.records.Field
+import expo.modules.kotlin.records.Record
+
+data class Query(
+  @Field
+  val sql: String,
+  @Field
+  val args: List<Any?>
+) : Record

package/android/src/main/java/expo/modules/sqlite/SQLiteHelpers.kt

@@ -2,7 +2,6 @@ package expo.modules.sqlite
 
 import java.io.File
 import java.io.IOException
-import java.util.ArrayList
 
 @Throws(IOException::class)
 internal fun ensureDirExists(dir: File): File {
@@ -77,7 +76,7 @@ private fun startsWithCaseInsensitive(str: String, substr: String): Boolean {
   return str.trimStart().startsWith(substr, true)
 }
 
-internal fun convertParamsToStringArray(paramArrayArg: ArrayList<Any?>): Array<String?> {
+internal fun convertParamsToStringArray(paramArrayArg: List<Any?>): Array<String?> {
   return paramArrayArg.map { param ->
     when (param) {
       is String -> unescapeBlob(param)

package/android/src/main/java/expo/modules/sqlite/SQLiteModule.kt

@@ -4,31 +4,30 @@ package expo.modules.sqlite
 import android.content.Context
 import android.database.Cursor
 import android.database.sqlite.SQLiteDatabase
-import expo.modules.core.ExportedModule
-import expo.modules.core.Promise
-import expo.modules.core.interfaces.ExpoMethod
+import expo.modules.kotlin.exception.Exceptions
+import expo.modules.kotlin.modules.Module
+import expo.modules.kotlin.modules.ModuleDefinition
 import java.io.File
 import java.io.IOException
 import java.util.*
 
-private val TAG = SQLiteModule::class.java.simpleName
-private val EMPTY_ROWS = arrayOf<Array<Any?>>()
-private val EMPTY_COLUMNS = arrayOf<String?>()
+private val EMPTY_ROWS = emptyArray<Array<Any?>>()
+private val EMPTY_COLUMNS = emptyArray<String?>()
 private val EMPTY_RESULT = SQLiteModule.SQLitePluginResult(EMPTY_ROWS, EMPTY_COLUMNS, 0, 0, null)
 private val DATABASES: MutableMap<String, SQLiteDatabase?> = HashMap()
 
-class SQLiteModule(private val mContext: Context) : ExportedModule(mContext) {
-  override fun getName(): String {
-    return "ExpoSQLite"
-  }
+class SQLiteModule : Module() {
+  private val context: Context
+    get() = appContext.reactContext ?: throw Exceptions.ReactContextLost()
+
+  override fun definition() = ModuleDefinition {
+    Name("ExpoSQLite")
 
-  @ExpoMethod
-  fun exec(dbName: String, queries: ArrayList<ArrayList<Any>>, readOnly: Boolean, promise: Promise) {
-    try {
+    AsyncFunction("exec") { dbName: String, queries: List<Query>, readOnly: Boolean ->
       val db = getDatabase(dbName)
       val results = queries.map { sqlQuery ->
-        val sql = sqlQuery[0] as String
-        val bindArgs = convertParamsToStringArray(sqlQuery[1] as ArrayList<Any?>)
+        val sql = sqlQuery.sql
+        val bindArgs = convertParamsToStringArray(sqlQuery.args)
         try {
           if (isSelect(sql)) {
             doSelectInBackgroundAndPossiblyThrow(sql, bindArgs, db)
@@ -43,37 +42,27 @@ class SQLiteModule(private val mContext: Context) : ExportedModule(mContext) {
           SQLitePluginResult(EMPTY_ROWS, EMPTY_COLUMNS, 0, 0, e)
         }
       }
-      val data = pluginResultsToPrimitiveData(results)
-      promise.resolve(data)
-    } catch (e: Exception) {
-      promise.reject("SQLiteError", e)
+      return@AsyncFunction pluginResultsToPrimitiveData(results)
     }
-  }
 
-  @ExpoMethod
-  fun close(dbName: String, promise: Promise) {
-    DATABASES
-      .remove(dbName)
-      ?.close()
-    promise.resolve(null)
-  }
-
-  @ExpoMethod
-  fun deleteAsync(dbName: String, promise: Promise) {
-    val errorCode = "SQLiteError"
-    if (DATABASES.containsKey(dbName)) {
-      promise.reject(errorCode, "Unable to delete database '$dbName' that is currently open. Close it prior to deletion.")
-    }
-    val dbFile = File(pathForDatabaseName(dbName))
-    if (!dbFile.exists()) {
-      promise.reject(errorCode, "Database '$dbName' not found")
-      return
+    AsyncFunction("close") { dbName: String ->
+      DATABASES
+        .remove(dbName)
+        ?.close()
     }
-    if (!dbFile.delete()) {
-      promise.reject(errorCode, "Unable to delete the database file for '$dbName' database")
-      return
+
+    AsyncFunction("deleteAsync") { dbName: String ->
+      if (DATABASES.containsKey(dbName)) {
+        throw OpenDatabaseException(dbName)
+      }
+      val dbFile = File(pathForDatabaseName(dbName))
+      if (!dbFile.exists()) {
+        throw DatabaseNotFoundException(dbName)
+      }
+      if (!dbFile.delete()) {
+        throw DeleteDatabaseException(dbName)
+      }
     }
-    promise.resolve(null)
   }
 
   // do a update/delete/insert operation
@@ -143,6 +132,7 @@ class SQLiteModule(private val mContext: Context) : ExportedModule(mContext) {
         // convert byte[] to binary string; it's good enough, because
         // WebSQL doesn't support blobs anyway
         String(cursor.getBlob(index))
+
       Cursor.FIELD_TYPE_STRING -> cursor.getString(index)
       else -> null
     }
@@ -150,7 +140,7 @@ class SQLiteModule(private val mContext: Context) : ExportedModule(mContext) {
 
   @Throws(IOException::class)
   private fun pathForDatabaseName(name: String): String {
-    val directory = File("${mContext.filesDir}${File.separator}SQLite")
+    val directory = File("${context.filesDir}${File.separator}SQLite")
     ensureDirExists(directory)
     return "$directory${File.separator}$name"
   }

package/build/SQLite.d.ts

@@ -1,5 +1,49 @@
 import './polyfillNextTick';
-import { WebSQLDatabase } from './SQLite.types';
+import type { Query, ResultSet, ResultSetError, SQLiteCallback, SQLTransactionAsyncCallback, SQLTransactionAsync, SQLTransactionCallback, SQLTransactionErrorCallback } from './SQLite.types';
+/** The database returned by `openDatabase()` */
+export declare class SQLiteDatabase {
+    _name: string;
+    _closed: boolean;
+    constructor(name: string);
+    /**
+     * Executes the SQL statement and returns a callback resolving with the result.
+     */
+    exec(queries: Query[], readOnly: boolean, callback: SQLiteCallback): void;
+    /**
+     * Executes the SQL statement and returns a Promise resolving with the result.
+     */
+    execAsync(queries: Query[], readOnly: boolean): Promise<(ResultSetError | ResultSet)[]>;
+    /**
+     * @deprecated Use `closeAsync()` instead.
+     */
+    close: () => void;
+    /**
+     * Close the database.
+     */
+    closeAsync(): void;
+    /**
+     * Delete the database file.
+     * > The database has to be closed prior to deletion.
+     */
+    deleteAsync(): Promise<void>;
+    /**
+     * Creates a new transaction with Promise support.
+     * @param asyncCallback A `SQLTransactionAsyncCallback` function that can perform SQL statements in a transaction.
+     * @param readOnly true if all the SQL statements in the callback are read only.
+     */
+    transactionAsync(asyncCallback: SQLTransactionAsyncCallback, readOnly?: boolean): Promise<void>;
+    version: string;
+    /**
+     * Execute a database transaction.
+     * @param callback A function representing the transaction to perform. Takes a Transaction
+     * (see below) as its only parameter, on which it can add SQL statements to execute.
+     * @param errorCallback Called if an error occurred processing this transaction. Takes a single
+     * parameter describing the error.
+     * @param successCallback Called when the transaction has completed executing on the database.
+     */
+    transaction(callback: SQLTransactionCallback, errorCallback?: SQLTransactionErrorCallback, successCallback?: () => void): void;
+    readTransaction(callback: SQLTransactionCallback, errorCallback?: SQLTransactionErrorCallback, successCallback?: () => void): void;
+}
 /**
  * Open a database, creating it if it doesn't exist, and return a `Database` object. On disk,
  * the database will be created under the app's [documents directory](./filesystem), i.e.
@@ -13,5 +57,15 @@ import { WebSQLDatabase } from './SQLite.types';
  * @param callback
  * @return
  */
-export declare function openDatabase(name: string, version?: string, description?: string, size?: number, callback?: (db: WebSQLDatabase) => void): WebSQLDatabase;
+export declare function openDatabase(name: string, version?: string, description?: string, size?: number, callback?: (db: SQLiteDatabase) => void): SQLiteDatabase;
+/**
+ * Internal data structure for the async transaction API.
+ * @internal
+ */
+export declare class ExpoSQLTransactionAsync implements SQLTransactionAsync {
+    private readonly db;
+    private readonly readOnly;
+    constructor(db: SQLiteDatabase, readOnly: boolean);
+    executeSqlAsync(sqlStatement: string, args?: (number | string)[]): Promise<ResultSetError | ResultSet>;
+}
 //# sourceMappingURL=SQLite.d.ts.map

package/build/SQLite.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SQLite.d.ts","sourceRoot":"","sources":["../src/SQLite.ts"],"names":[],"mappings":"AAAA,OAAO,oBAAoB,CAAC;AAM5B,OAAO,EAAoD,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAuFlG;;;;;;;;;;;;GAYG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,MAAc,EACvB,WAAW,GAAE,MAAa,EAC1B,IAAI,GAAE,MAAU,EAChB,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,cAAc,KAAK,IAAI,GACtC,cAAc,CAShB"}
+{"version":3,"file":"SQLite.d.ts","sourceRoot":"","sources":["../src/SQLite.ts"],"names":[],"mappings":"AAAA,OAAO,oBAAoB,CAAC;AAM5B,OAAO,KAAK,EACV,KAAK,EACL,SAAS,EACT,cAAc,EACd,cAAc,EACd,2BAA2B,EAC3B,mBAAmB,EACnB,sBAAsB,EACtB,2BAA2B,EAC5B,MAAM,gBAAgB,CAAC;AAYxB,gDAAgD;AAChD,qBAAa,cAAc;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,OAAO,CAAS;gBAEb,IAAI,EAAE,MAAM;IAIxB;;OAEG;IACH,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,GAAG,IAAI;IAgBzE;;OAEG;IACG,SAAS,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC,cAAc,GAAG,SAAS,CAAC,EAAE,CAAC;IAa7F;;OAEG;IACH,KAAK,QAKS,IAAI,CALM;IAExB;;OAEG;IACH,UAAU,IAAI,IAAI;IAKlB;;;OAGG;IACH,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAU5B;;;;OAIG;IACG,gBAAgB,CACpB,aAAa,EAAE,2BAA2B,EAC1C,QAAQ,GAAE,OAAe,GACxB,OAAO,CAAC,IAAI,CAAC;IAahB,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;;OAOG;IAEH,WAAW,CACT,QAAQ,EAAE,sBAAsB,EAChC,aAAa,CAAC,EAAE,2BAA2B,EAC3C,eAAe,CAAC,EAAE,MAAM,IAAI,GAC3B,IAAI;IAGP,eAAe,CACb,QAAQ,EAAE,sBAAsB,EAChC,aAAa,CAAC,EAAE,2BAA2B,EAC3C,eAAe,CAAC,EAAE,MAAM,IAAI,GAC3B,IAAI;CACR;AA0CD;;;;;;;;;;;;GAYG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,MAAc,EACvB,WAAW,GAAE,MAAa,EAC1B,IAAI,GAAE,MAAU,EAChB,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,cAAc,KAAK,IAAI,GACtC,cAAc,CAWhB;AAED;;;GAGG;AACH,qBAAa,uBAAwB,YAAW,mBAAmB;IACrD,OAAO,CAAC,QAAQ,CAAC,EAAE;IAAkB,OAAO,CAAC,QAAQ,CAAC,QAAQ;gBAA7C,EAAE,EAAE,cAAc,EAAmB,QAAQ,EAAE,OAAO;IAE7E,eAAe,CACnB,YAAY,EAAE,MAAM,EACpB,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GACzB,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;CAOvC"}

package/build/SQLite.js

@@ -10,12 +10,16 @@ function zipObject(keys, values) {
     }
     return result;
 }
-class SQLiteDatabase {
+/** The database returned by `openDatabase()` */
+export class SQLiteDatabase {
     _name;
     _closed = false;
     constructor(name) {
         this._name = name;
     }
+    /**
+     * Executes the SQL statement and returns a callback resolving with the result.
+     */
     exec(queries, readOnly, callback) {
         if (this._closed) {
             throw new Error(`The SQLite database is closed`);
@@ -27,19 +31,64 @@ class SQLiteDatabase {
             callback(error instanceof Error ? error : new Error(error));
         });
     }
-    close() {
+    /**
+     * Executes the SQL statement and returns a Promise resolving with the result.
+     */
+    async execAsync(queries, readOnly) {
+        if (this._closed) {
+            throw new Error(`The SQLite database is closed`);
+        }
+        const nativeResultSets = await ExpoSQLite.exec(this._name, queries.map(_serializeQuery), readOnly);
+        return nativeResultSets.map(_deserializeResultSet);
+    }
+    /**
+     * @deprecated Use `closeAsync()` instead.
+     */
+    close = this.closeAsync;
+    /**
+     * Close the database.
+     */
+    closeAsync() {
         this._closed = true;
         return ExpoSQLite.close(this._name);
     }
+    /**
+     * Delete the database file.
+     * > The database has to be closed prior to deletion.
+     */
     deleteAsync() {
         if (!this._closed) {
             throw new Error(`Unable to delete '${this._name}' database that is currently open. Close it prior to deletion.`);
         }
         return ExpoSQLite.deleteAsync(this._name);
     }
+    /**
+     * Creates a new transaction with Promise support.
+     * @param asyncCallback A `SQLTransactionAsyncCallback` function that can perform SQL statements in a transaction.
+     * @param readOnly true if all the SQL statements in the callback are read only.
+     */
+    async transactionAsync(asyncCallback, readOnly = false) {
+        await this.execAsync([{ sql: 'BEGIN;', args: [] }], false);
+        try {
+            const transaction = new ExpoSQLTransactionAsync(this, readOnly);
+            await asyncCallback(transaction);
+            await this.execAsync([{ sql: 'END;', args: [] }], false);
+        }
+        catch (e) {
+            await this.execAsync([{ sql: 'ROLLBACK;', args: [] }], false);
+            throw e;
+        }
+    }
+    // @ts-expect-error: properties that are added from websql
+    version;
 }
 function _serializeQuery(query) {
-    return [query.sql, Platform.OS === 'android' ? query.args.map(_escapeBlob) : query.args];
+    return Platform.OS === 'android'
+        ? {
+            sql: query.sql,
+            args: query.args.map(_escapeBlob),
+        }
+        : [query.sql, query.args];
 }
 function _deserializeResultSet(nativeResult) {
     const [errorMessage, insertId, rowsAffected, columns, rows] = nativeResult;
@@ -88,8 +137,26 @@ export function openDatabase(name, version = '1.0', description = name, size = 1
     }
     const db = _openExpoSQLiteDatabase(name, version, description, size, callback);
     db.exec = db._db.exec.bind(db._db);
-    db.closeAsync = db._db.close.bind(db._db);
+    db.execAsync = db._db.execAsync.bind(db._db);
+    db.closeAsync = db._db.closeAsync.bind(db._db);
     db.deleteAsync = db._db.deleteAsync.bind(db._db);
+    db.transactionAsync = db._db.transactionAsync.bind(db._db);
     return db;
 }
+/**
+ * Internal data structure for the async transaction API.
+ * @internal
+ */
+export class ExpoSQLTransactionAsync {
+    db;
+    readOnly;
+    constructor(db, readOnly) {
+        this.db = db;
+        this.readOnly = readOnly;
+    }
+    async executeSqlAsync(sqlStatement, args) {
+        const resultSets = await this.db.execAsync([{ sql: sqlStatement, args: args ?? [] }], this.readOnly);
+        return resultSets[0];
+    }
+}
 //# sourceMappingURL=SQLite.js.map

package/build/SQLite.js.map

@@ -1 +1 @@
-{"version":3,"file":"SQLite.js","sourceRoot":"","sources":["../src/SQLite.ts"],"names":[],"mappings":"AAAA,OAAO,oBAAoB,CAAC;AAE5B,OAAO,kBAAkB,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAIxC,MAAM,UAAU,GAAG,mBAAmB,CAAC,YAAY,CAAC,CAAC;AAErD,SAAS,SAAS,CAAC,IAAc,EAAE,MAAa;IAC9C,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACpC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;KAC7B;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,cAAc;IAClB,KAAK,CAAS;IACd,OAAO,GAAY,KAAK,CAAC;IAEzB,YAAY,IAAY;QACtB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED,IAAI,CAAC,OAAgB,EAAE,QAAiB,EAAE,QAAwB;QAChE,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;SAClD;QAED,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,QAAQ,CAAC,CAAC,IAAI,CACtE,CAAC,gBAAgB,EAAE,EAAE;YACnB,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC,CAAC;QAC9D,CAAC,EACD,CAAC,KAAK,EAAE,EAAE;YACR,0FAA0F;YAC1F,QAAQ,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;QAC9D,CAAC,CACF,CAAC;IACJ,CAAC;IAED,KAAK;QACH,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,OAAO,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;IAED,WAAW;QACT,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,MAAM,IAAI,KAAK,CACb,qBAAqB,IAAI,CAAC,KAAK,gEAAgE,CAChG,CAAC;SACH;QAED,OAAO,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5C,CAAC;CACF;AAED,SAAS,eAAe,CAAC,KAAY;IACnC,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,QAAQ,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AAC3F,CAAC;AAED,SAAS,qBAAqB,CAAC,YAAY;IACzC,MAAM,CAAC,YAAY,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,YAAY,CAAC;IAC3E,iGAAiG;IACjG,wBAAwB;IACxB,IAAI,YAAY,KAAK,IAAI,EAAE;QACzB,OAAO,EAAE,KAAK,EAAE,IAAI,KAAK,CAAC,YAAY,CAAC,EAAoB,CAAC;KAC7D;IAED,OAAO;QACL,QAAQ;QACR,YAAY;QACZ,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;KACjD,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAI,IAAO;IAC7B,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QAC5B,qCAAqC;QACrC,OAAO,IAAI;aACR,OAAO,CAAC,SAAS,EAAE,cAAc,CAAC;aAClC,OAAO,CAAC,SAAS,EAAE,cAAc,CAAC;aAClC,OAAO,CAAC,SAAS,EAAE,cAAc,CAAQ,CAAC;QAC7C,oCAAoC;KACrC;SAAM;QACL,OAAO,IAAI,CAAC;KACb;AACH,CAAC;AAED,MAAM,uBAAuB,GAAG,kBAAkB,CAAC,cAAc,CAAC,CAAC;AAEnE,2BAA2B;AAC3B;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,YAAY,CAC1B,IAAY,EACZ,UAAkB,KAAK,EACvB,cAAsB,IAAI,EAC1B,OAAe,CAAC,EAChB,QAAuC;IAEvC,IAAI,IAAI,KAAK,SAAS,EAAE;QACtB,MAAM,IAAI,SAAS,CAAC,yCAAyC,CAAC,CAAC;KAChE;IACD,MAAM,EAAE,GAAG,uBAAuB,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC/E,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IACnC,EAAE,CAAC,UAAU,GAAG,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IAC1C,EAAE,CAAC,WAAW,GAAG,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IACjD,OAAO,EAAE,CAAC;AACZ,CAAC","sourcesContent":["import './polyfillNextTick';\n\nimport customOpenDatabase from '@expo/websql/custom';\nimport { requireNativeModule } from 'expo-modules-core';\nimport { Platform } from 'react-native';\n\nimport { Query, ResultSet, ResultSetError, SQLiteCallback, WebSQLDatabase } from './SQLite.types';\n\nconst ExpoSQLite = requireNativeModule('ExpoSQLite');\n\nfunction zipObject(keys: string[], values: any[]) {\n  const result = {};\n  for (let i = 0; i < keys.length; i++) {\n    result[keys[i]] = values[i];\n  }\n  return result;\n}\n\nclass SQLiteDatabase {\n  _name: string;\n  _closed: boolean = false;\n\n  constructor(name: string) {\n    this._name = name;\n  }\n\n  exec(queries: Query[], readOnly: boolean, callback: SQLiteCallback): void {\n    if (this._closed) {\n      throw new Error(`The SQLite database is closed`);\n    }\n\n    ExpoSQLite.exec(this._name, queries.map(_serializeQuery), readOnly).then(\n      (nativeResultSets) => {\n        callback(null, nativeResultSets.map(_deserializeResultSet));\n      },\n      (error) => {\n        // TODO: make the native API consistently reject with an error, not a string or other type\n        callback(error instanceof Error ? error : new Error(error));\n      }\n    );\n  }\n\n  close() {\n    this._closed = true;\n    return ExpoSQLite.close(this._name);\n  }\n\n  deleteAsync(): Promise<void> {\n    if (!this._closed) {\n      throw new Error(\n        `Unable to delete '${this._name}' database that is currently open. Close it prior to deletion.`\n      );\n    }\n\n    return ExpoSQLite.deleteAsync(this._name);\n  }\n}\n\nfunction _serializeQuery(query: Query): [string, unknown[]] {\n  return [query.sql, Platform.OS === 'android' ? query.args.map(_escapeBlob) : query.args];\n}\n\nfunction _deserializeResultSet(nativeResult): ResultSet | ResultSetError {\n  const [errorMessage, insertId, rowsAffected, columns, rows] = nativeResult;\n  // TODO: send more structured error information from the native module so we can better construct\n  // a SQLException object\n  if (errorMessage !== null) {\n    return { error: new Error(errorMessage) } as ResultSetError;\n  }\n\n  return {\n    insertId,\n    rowsAffected,\n    rows: rows.map((row) => zipObject(columns, row)),\n  };\n}\n\nfunction _escapeBlob<T>(data: T): T {\n  if (typeof data === 'string') {\n    /* eslint-disable no-control-regex */\n    return data\n      .replace(/\\u0002/g, '\\u0002\\u0002')\n      .replace(/\\u0001/g, '\\u0001\\u0002')\n      .replace(/\\u0000/g, '\\u0001\\u0001') as any;\n    /* eslint-enable no-control-regex */\n  } else {\n    return data;\n  }\n}\n\nconst _openExpoSQLiteDatabase = customOpenDatabase(SQLiteDatabase);\n\n// @needsAudit @docsMissing\n/**\n * Open a database, creating it if it doesn't exist, and return a `Database` object. On disk,\n * the database will be created under the app's [documents directory](./filesystem), i.e.\n * `${FileSystem.documentDirectory}/SQLite/${name}`.\n * > The `version`, `description` and `size` arguments are ignored, but are accepted by the function\n * for compatibility with the WebSQL specification.\n * @param name Name of the database file to open.\n * @param version\n * @param description\n * @param size\n * @param callback\n * @return\n */\nexport function openDatabase(\n  name: string,\n  version: string = '1.0',\n  description: string = name,\n  size: number = 1,\n  callback?: (db: WebSQLDatabase) => void\n): WebSQLDatabase {\n  if (name === undefined) {\n    throw new TypeError(`The database name must not be undefined`);\n  }\n  const db = _openExpoSQLiteDatabase(name, version, description, size, callback);\n  db.exec = db._db.exec.bind(db._db);\n  db.closeAsync = db._db.close.bind(db._db);\n  db.deleteAsync = db._db.deleteAsync.bind(db._db);\n  return db;\n}\n"]}
+{"version":3,"file":"SQLite.js","sourceRoot":"","sources":["../src/SQLite.ts"],"names":[],"mappings":"AAAA,OAAO,oBAAoB,CAAC;AAE5B,OAAO,kBAAkB,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAaxC,MAAM,UAAU,GAAG,mBAAmB,CAAC,YAAY,CAAC,CAAC;AAErD,SAAS,SAAS,CAAC,IAAc,EAAE,MAAa;IAC9C,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACpC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;KAC7B;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,gDAAgD;AAChD,MAAM,OAAO,cAAc;IACzB,KAAK,CAAS;IACd,OAAO,GAAY,KAAK,CAAC;IAEzB,YAAY,IAAY;QACtB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,OAAgB,EAAE,QAAiB,EAAE,QAAwB;QAChE,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;SAClD;QAED,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,QAAQ,CAAC,CAAC,IAAI,CACtE,CAAC,gBAAgB,EAAE,EAAE;YACnB,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC,CAAC;QAC9D,CAAC,EACD,CAAC,KAAK,EAAE,EAAE;YACR,0FAA0F;YAC1F,QAAQ,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;QAC9D,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,OAAgB,EAAE,QAAiB;QACjD,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;SAClD;QAED,MAAM,gBAAgB,GAAG,MAAM,UAAU,CAAC,IAAI,CAC5C,IAAI,CAAC,KAAK,EACV,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,EAC5B,QAAQ,CACT,CAAC;QACF,OAAO,gBAAgB,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACH,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC;IAExB;;OAEG;IACH,UAAU;QACR,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,OAAO,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;IAED;;;OAGG;IACH,WAAW;QACT,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,MAAM,IAAI,KAAK,CACb,qBAAqB,IAAI,CAAC,KAAK,gEAAgE,CAChG,CAAC;SACH;QAED,OAAO,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5C,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,gBAAgB,CACpB,aAA0C,EAC1C,WAAoB,KAAK;QAEzB,MAAM,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;QAC3D,IAAI;YACF,MAAM,WAAW,GAAG,IAAI,uBAAuB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAChE,MAAM,aAAa,CAAC,WAAW,CAAC,CAAC;YACjC,MAAM,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;SAC1D;QAAC,OAAO,CAAU,EAAE;YACnB,MAAM,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;YAC9D,MAAM,CAAC,CAAC;SACT;IACH,CAAC;IAED,0DAA0D;IAC1D,OAAO,CAAS;CAuBjB;AAED,SAAS,eAAe,CAAC,KAAY;IACnC,OAAO,QAAQ,CAAC,EAAE,KAAK,SAAS;QAC9B,CAAC,CAAC;YACE,GAAG,EAAE,KAAK,CAAC,GAAG;YACd,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC;SAClC;QACH,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC;AAED,SAAS,qBAAqB,CAAC,YAAY;IACzC,MAAM,CAAC,YAAY,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,YAAY,CAAC;IAC3E,iGAAiG;IACjG,wBAAwB;IACxB,IAAI,YAAY,KAAK,IAAI,EAAE;QACzB,OAAO,EAAE,KAAK,EAAE,IAAI,KAAK,CAAC,YAAY,CAAC,EAAoB,CAAC;KAC7D;IAED,OAAO;QACL,QAAQ;QACR,YAAY;QACZ,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;KACjD,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAI,IAAO;IAC7B,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QAC5B,qCAAqC;QACrC,OAAO,IAAI;aACR,OAAO,CAAC,SAAS,EAAE,cAAc,CAAC;aAClC,OAAO,CAAC,SAAS,EAAE,cAAc,CAAC;aAClC,OAAO,CAAC,SAAS,EAAE,cAAc,CAAQ,CAAC;QAC7C,oCAAoC;KACrC;SAAM;QACL,OAAO,IAAI,CAAC;KACb;AACH,CAAC;AAED,MAAM,uBAAuB,GAAG,kBAAkB,CAAC,cAAc,CAAC,CAAC;AAEnE,2BAA2B;AAC3B;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,YAAY,CAC1B,IAAY,EACZ,UAAkB,KAAK,EACvB,cAAsB,IAAI,EAC1B,OAAe,CAAC,EAChB,QAAuC;IAEvC,IAAI,IAAI,KAAK,SAAS,EAAE;QACtB,MAAM,IAAI,SAAS,CAAC,yCAAyC,CAAC,CAAC;KAChE;IACD,MAAM,EAAE,GAAG,uBAAuB,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC/E,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IACnC,EAAE,CAAC,SAAS,GAAG,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IAC7C,EAAE,CAAC,UAAU,GAAG,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IAC/C,EAAE,CAAC,WAAW,GAAG,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IACjD,EAAE,CAAC,gBAAgB,GAAG,EAAE,CAAC,GAAG,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IAC3D,OAAO,EAAE,CAAC;AACZ,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,uBAAuB;IACL;IAAqC;IAAlE,YAA6B,EAAkB,EAAmB,QAAiB;QAAtD,OAAE,GAAF,EAAE,CAAgB;QAAmB,aAAQ,GAAR,QAAQ,CAAS;IAAG,CAAC;IAEvF,KAAK,CAAC,eAAe,CACnB,YAAoB,EACpB,IAA0B;QAE1B,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,SAAS,CACxC,CAAC,EAAE,GAAG,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,EAAE,CAAC,EACzC,IAAI,CAAC,QAAQ,CACd,CAAC;QACF,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC;IACvB,CAAC;CACF","sourcesContent":["import './polyfillNextTick';\n\nimport customOpenDatabase from '@expo/websql/custom';\nimport { requireNativeModule } from 'expo-modules-core';\nimport { Platform } from 'react-native';\n\nimport type {\n  Query,\n  ResultSet,\n  ResultSetError,\n  SQLiteCallback,\n  SQLTransactionAsyncCallback,\n  SQLTransactionAsync,\n  SQLTransactionCallback,\n  SQLTransactionErrorCallback,\n} from './SQLite.types';\n\nconst ExpoSQLite = requireNativeModule('ExpoSQLite');\n\nfunction zipObject(keys: string[], values: any[]) {\n  const result = {};\n  for (let i = 0; i < keys.length; i++) {\n    result[keys[i]] = values[i];\n  }\n  return result;\n}\n\n/** The database returned by `openDatabase()` */\nexport class SQLiteDatabase {\n  _name: string;\n  _closed: boolean = false;\n\n  constructor(name: string) {\n    this._name = name;\n  }\n\n  /**\n   * Executes the SQL statement and returns a callback resolving with the result.\n   */\n  exec(queries: Query[], readOnly: boolean, callback: SQLiteCallback): void {\n    if (this._closed) {\n      throw new Error(`The SQLite database is closed`);\n    }\n\n    ExpoSQLite.exec(this._name, queries.map(_serializeQuery), readOnly).then(\n      (nativeResultSets) => {\n        callback(null, nativeResultSets.map(_deserializeResultSet));\n      },\n      (error) => {\n        // TODO: make the native API consistently reject with an error, not a string or other type\n        callback(error instanceof Error ? error : new Error(error));\n      }\n    );\n  }\n\n  /**\n   * Executes the SQL statement and returns a Promise resolving with the result.\n   */\n  async execAsync(queries: Query[], readOnly: boolean): Promise<(ResultSetError | ResultSet)[]> {\n    if (this._closed) {\n      throw new Error(`The SQLite database is closed`);\n    }\n\n    const nativeResultSets = await ExpoSQLite.exec(\n      this._name,\n      queries.map(_serializeQuery),\n      readOnly\n    );\n    return nativeResultSets.map(_deserializeResultSet);\n  }\n\n  /**\n   * @deprecated Use `closeAsync()` instead.\n   */\n  close = this.closeAsync;\n\n  /**\n   * Close the database.\n   */\n  closeAsync(): void {\n    this._closed = true;\n    return ExpoSQLite.close(this._name);\n  }\n\n  /**\n   * Delete the database file.\n   * > The database has to be closed prior to deletion.\n   */\n  deleteAsync(): Promise<void> {\n    if (!this._closed) {\n      throw new Error(\n        `Unable to delete '${this._name}' database that is currently open. Close it prior to deletion.`\n      );\n    }\n\n    return ExpoSQLite.deleteAsync(this._name);\n  }\n\n  /**\n   * Creates a new transaction with Promise support.\n   * @param asyncCallback A `SQLTransactionAsyncCallback` function that can perform SQL statements in a transaction.\n   * @param readOnly true if all the SQL statements in the callback are read only.\n   */\n  async transactionAsync(\n    asyncCallback: SQLTransactionAsyncCallback,\n    readOnly: boolean = false\n  ): Promise<void> {\n    await this.execAsync([{ sql: 'BEGIN;', args: [] }], false);\n    try {\n      const transaction = new ExpoSQLTransactionAsync(this, readOnly);\n      await asyncCallback(transaction);\n      await this.execAsync([{ sql: 'END;', args: [] }], false);\n    } catch (e: unknown) {\n      await this.execAsync([{ sql: 'ROLLBACK;', args: [] }], false);\n      throw e;\n    }\n  }\n\n  // @ts-expect-error: properties that are added from websql\n  version: string;\n\n  /**\n   * Execute a database transaction.\n   * @param callback A function representing the transaction to perform. Takes a Transaction\n   * (see below) as its only parameter, on which it can add SQL statements to execute.\n   * @param errorCallback Called if an error occurred processing this transaction. Takes a single\n   * parameter describing the error.\n   * @param successCallback Called when the transaction has completed executing on the database.\n   */\n  // @ts-expect-error: properties that are added from websql\n  transaction(\n    callback: SQLTransactionCallback,\n    errorCallback?: SQLTransactionErrorCallback,\n    successCallback?: () => void\n  ): void;\n\n  // @ts-expect-error: properties that are added from websql\n  readTransaction(\n    callback: SQLTransactionCallback,\n    errorCallback?: SQLTransactionErrorCallback,\n    successCallback?: () => void\n  ): void;\n}\n\nfunction _serializeQuery(query: Query): Query | [string, any[]] {\n  return Platform.OS === 'android'\n    ? {\n        sql: query.sql,\n        args: query.args.map(_escapeBlob),\n      }\n    : [query.sql, query.args];\n}\n\nfunction _deserializeResultSet(nativeResult): ResultSet | ResultSetError {\n  const [errorMessage, insertId, rowsAffected, columns, rows] = nativeResult;\n  // TODO: send more structured error information from the native module so we can better construct\n  // a SQLException object\n  if (errorMessage !== null) {\n    return { error: new Error(errorMessage) } as ResultSetError;\n  }\n\n  return {\n    insertId,\n    rowsAffected,\n    rows: rows.map((row) => zipObject(columns, row)),\n  };\n}\n\nfunction _escapeBlob<T>(data: T): T {\n  if (typeof data === 'string') {\n    /* eslint-disable no-control-regex */\n    return data\n      .replace(/\\u0002/g, '\\u0002\\u0002')\n      .replace(/\\u0001/g, '\\u0001\\u0002')\n      .replace(/\\u0000/g, '\\u0001\\u0001') as any;\n    /* eslint-enable no-control-regex */\n  } else {\n    return data;\n  }\n}\n\nconst _openExpoSQLiteDatabase = customOpenDatabase(SQLiteDatabase);\n\n// @needsAudit @docsMissing\n/**\n * Open a database, creating it if it doesn't exist, and return a `Database` object. On disk,\n * the database will be created under the app's [documents directory](./filesystem), i.e.\n * `${FileSystem.documentDirectory}/SQLite/${name}`.\n * > The `version`, `description` and `size` arguments are ignored, but are accepted by the function\n * for compatibility with the WebSQL specification.\n * @param name Name of the database file to open.\n * @param version\n * @param description\n * @param size\n * @param callback\n * @return\n */\nexport function openDatabase(\n  name: string,\n  version: string = '1.0',\n  description: string = name,\n  size: number = 1,\n  callback?: (db: SQLiteDatabase) => void\n): SQLiteDatabase {\n  if (name === undefined) {\n    throw new TypeError(`The database name must not be undefined`);\n  }\n  const db = _openExpoSQLiteDatabase(name, version, description, size, callback);\n  db.exec = db._db.exec.bind(db._db);\n  db.execAsync = db._db.execAsync.bind(db._db);\n  db.closeAsync = db._db.closeAsync.bind(db._db);\n  db.deleteAsync = db._db.deleteAsync.bind(db._db);\n  db.transactionAsync = db._db.transactionAsync.bind(db._db);\n  return db;\n}\n\n/**\n * Internal data structure for the async transaction API.\n * @internal\n */\nexport class ExpoSQLTransactionAsync implements SQLTransactionAsync {\n  constructor(private readonly db: SQLiteDatabase, private readonly readOnly: boolean) {}\n\n  async executeSqlAsync(\n    sqlStatement: string,\n    args?: (number | string)[]\n  ): Promise<ResultSetError | ResultSet> {\n    const resultSets = await this.db.execAsync(\n      [{ sql: sqlStatement, args: args ?? [] }],\n      this.readOnly\n    );\n    return resultSets[0];\n  }\n}\n"]}

package/build/SQLite.types.d.ts

@@ -84,6 +84,7 @@ export declare class SQLError {
     code: number;
     message: string;
 }
+/** @deprecated Use `SQLiteDatabase` instead. */
 export interface WebSQLDatabase extends Database {
     exec(queries: Query[], readOnly: boolean, callback: SQLiteCallback): void;
     /**
@@ -100,14 +101,14 @@ export type Query = {
     sql: string;
     args: unknown[];
 };
-export type ResultSetError = {
+export interface ResultSetError {
     error: Error;
-};
+}
 /**
  * `ResultSet` objects are returned through second parameter of the `success` callback for the
  * `tx.executeSql()` method on a `SQLTransaction` (see above).
  */
-export type ResultSet = {
+export interface ResultSet {
     /**
      * The row ID of the row that the SQL statement inserted into the database, if a row was inserted.
      */
@@ -119,6 +120,13 @@ export type ResultSet = {
     rows: {
         [column: string]: any;
     }[];
-};
+}
 export type SQLiteCallback = (error?: Error | null, resultSet?: (ResultSetError | ResultSet)[]) => void;
+/** A transaction object to perform SQL statements in async mode. */
+export interface SQLTransactionAsync {
+    /** Executes a SQL statement in async mode. */
+    executeSqlAsync(sqlStatement: string, args?: (number | string)[]): Promise<ResultSetError | ResultSet>;
+}
+/** A transaction callback with given `SQLTransactionAsync` object to perform SQL statements in async mode. */
+export type SQLTransactionAsyncCallback = (transaction: SQLTransactionAsync) => Promise<void>;
 //# sourceMappingURL=SQLite.types.d.ts.map

package/build/SQLite.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SQLite.types.d.ts","sourceRoot":"","sources":["../src/SQLite.types.ts"],"names":[],"mappings":"AAQA,MAAM,WAAW,MAAM;IACrB,YAAY,CAAC,EAAE,CACb,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,aAAa,EAAE,MAAM,EACrB,gBAAgB,CAAC,EAAE,gBAAgB,KAChC,QAAQ,CAAC;CACf;AAGD,MAAM,MAAM,gBAAgB,GAAG,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;AAG5D;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;;OAOG;IACH,WAAW,CACT,QAAQ,EAAE,sBAAsB,EAChC,aAAa,CAAC,EAAE,2BAA2B,EAC3C,eAAe,CAAC,EAAE,MAAM,IAAI,GAC3B,IAAI,CAAC;IAER,eAAe,CACb,QAAQ,EAAE,sBAAsB,EAChC,aAAa,CAAC,EAAE,2BAA2B,EAC3C,eAAe,CAAC,EAAE,MAAM,IAAI,GAC3B,IAAI,CAAC;CACT;AAGD,MAAM,MAAM,sBAAsB,GAAG,CAAC,WAAW,EAAE,cAAc,KAAK,IAAI,CAAC;AAG3E,MAAM,MAAM,2BAA2B,GAAG,CAAC,KAAK,EAAE,QAAQ,KAAK,IAAI,CAAC;AAGpE;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;;;;;;;;;OAaG;IACH,UAAU,CACR,YAAY,EAAE,MAAM,EACpB,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC,EAAE,EACjC,QAAQ,CAAC,EAAE,oBAAoB,EAC/B,aAAa,CAAC,EAAE,yBAAyB,GACxC,IAAI,CAAC;CACT;AAGD,MAAM,MAAM,oBAAoB,GAAG,CAAC,WAAW,EAAE,cAAc,EAAE,SAAS,EAAE,YAAY,KAAK,IAAI,CAAC;AAGlG,MAAM,MAAM,yBAAyB,GAAG,CAAC,WAAW,EAAE,cAAc,EAAE,KAAK,EAAE,QAAQ,KAAK,OAAO,CAAC;AAGlG,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,mBAAmB,CAAC;CAC3B,CAAC;AAGF,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;IACzB;;;OAGG;IACH,MAAM,EAAE,GAAG,EAAE,CAAC;CACf;AAGD,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC;IAC3B,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC;IAC5B,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC;IAC3B,MAAM,CAAC,aAAa,EAAE,MAAM,CAAC;IAC7B,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC;IAC1B,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC;IAC9B,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC;IAE3B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB;AAGD,MAAM,WAAW,cAAe,SAAQ,QAAQ;IAC9C,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,GAAG,IAAI,CAAC;IAE1E;;OAEG;IACH,UAAU,IAAI,IAAI,CAAC;IAEnB;;;OAGG;IACH,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9B;AAGD,MAAM,MAAM,KAAK,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,OAAO,EAAE,CAAA;CAAE,CAAC;AAGrD,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,KAAK,CAAC;CACd,CAAC;AAGF;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE;QAAE,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EAAE,CAAC;CACnC,CAAC;AAGF,MAAM,MAAM,cAAc,GAAG,CAC3B,KAAK,CAAC,EAAE,KAAK,GAAG,IAAI,EACpB,SAAS,CAAC,EAAE,CAAC,cAAc,GAAG,SAAS,CAAC,EAAE,KACvC,IAAI,CAAC"}
+{"version":3,"file":"SQLite.types.d.ts","sourceRoot":"","sources":["../src/SQLite.types.ts"],"names":[],"mappings":"AAQA,MAAM,WAAW,MAAM;IACrB,YAAY,CAAC,EAAE,CACb,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,aAAa,EAAE,MAAM,EACrB,gBAAgB,CAAC,EAAE,gBAAgB,KAChC,QAAQ,CAAC;CACf;AAGD,MAAM,MAAM,gBAAgB,GAAG,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;AAG5D;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;;OAOG;IACH,WAAW,CACT,QAAQ,EAAE,sBAAsB,EAChC,aAAa,CAAC,EAAE,2BAA2B,EAC3C,eAAe,CAAC,EAAE,MAAM,IAAI,GAC3B,IAAI,CAAC;IAER,eAAe,CACb,QAAQ,EAAE,sBAAsB,EAChC,aAAa,CAAC,EAAE,2BAA2B,EAC3C,eAAe,CAAC,EAAE,MAAM,IAAI,GAC3B,IAAI,CAAC;CACT;AAGD,MAAM,MAAM,sBAAsB,GAAG,CAAC,WAAW,EAAE,cAAc,KAAK,IAAI,CAAC;AAG3E,MAAM,MAAM,2BAA2B,GAAG,CAAC,KAAK,EAAE,QAAQ,KAAK,IAAI,CAAC;AAGpE;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;;;;;;;;;OAaG;IACH,UAAU,CACR,YAAY,EAAE,MAAM,EACpB,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC,EAAE,EACjC,QAAQ,CAAC,EAAE,oBAAoB,EAC/B,aAAa,CAAC,EAAE,yBAAyB,GACxC,IAAI,CAAC;CACT;AAGD,MAAM,MAAM,oBAAoB,GAAG,CAAC,WAAW,EAAE,cAAc,EAAE,SAAS,EAAE,YAAY,KAAK,IAAI,CAAC;AAGlG,MAAM,MAAM,yBAAyB,GAAG,CAAC,WAAW,EAAE,cAAc,EAAE,KAAK,EAAE,QAAQ,KAAK,OAAO,CAAC;AAGlG,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,mBAAmB,CAAC;CAC3B,CAAC;AAGF,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;IACzB;;;OAGG;IACH,MAAM,EAAE,GAAG,EAAE,CAAC;CACf;AAGD,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC;IAC3B,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC;IAC5B,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC;IAC3B,MAAM,CAAC,aAAa,EAAE,MAAM,CAAC;IAC7B,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC;IAC1B,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC;IAC9B,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC;IAE3B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,gDAAgD;AAChD,MAAM,WAAW,cAAe,SAAQ,QAAQ;IAC9C,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,GAAG,IAAI,CAAC;IAE1E;;OAEG;IACH,UAAU,IAAI,IAAI,CAAC;IAEnB;;;OAGG;IACH,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9B;AAGD,MAAM,MAAM,KAAK,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,OAAO,EAAE,CAAA;CAAE,CAAC;AAGrD,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,KAAK,CAAC;CACd;AAGD;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE;QAAE,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EAAE,CAAC;CACnC;AAGD,MAAM,MAAM,cAAc,GAAG,CAC3B,KAAK,CAAC,EAAE,KAAK,GAAG,IAAI,EACpB,SAAS,CAAC,EAAE,CAAC,cAAc,GAAG,SAAS,CAAC,EAAE,KACvC,IAAI,CAAC;AAEV,oEAAoE;AACpE,MAAM,WAAW,mBAAmB;IAClC,8CAA8C;IAC9C,eAAe,CACb,YAAY,EAAE,MAAM,EACpB,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GACzB,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CAAC;CACxC;AAED,8GAA8G;AAC9G,MAAM,MAAM,2BAA2B,GAAG,CAAC,WAAW,EAAE,mBAAmB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC"}

package/build/SQLite.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"SQLite.types.js","sourceRoot":"","sources":["../src/SQLite.types.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,8CAA8C;AAC9C,gDAAgD;AAChD,2DAA2D;AAC3D,EAAE;AACF,0EAA0E","sourcesContent":["// Definitions copied from `@types/websql` as we want\n// to expose a custom version of the API that:\n// - uses primitive `string` instead of `String`\n// - excludes some methods that are not exposed by our API.\n//\n// Original definitions by: TeamworkGuy2 <https://github.com/TeamworkGuy2>\n\n// @docsMissing\nexport interface Window {\n  openDatabase?: (\n    name: string,\n    version: string,\n    displayName: string,\n    estimatedSize: number,\n    creationCallback?: DatabaseCallback\n  ) => Database;\n}\n\n// @docsMissing\nexport type DatabaseCallback = (database: Database) => void;\n\n// @needsAudit @docsMissing\n/**\n * `Database` objects are returned by calls to `SQLite.openDatabase()`. Such an object represents a\n * connection to a database on your device.\n */\nexport interface Database {\n  version: string;\n\n  /**\n   * Execute a database transaction.\n   * @param callback A function representing the transaction to perform. Takes a Transaction\n   * (see below) as its only parameter, on which it can add SQL statements to execute.\n   * @param errorCallback Called if an error occurred processing this transaction. Takes a single\n   * parameter describing the error.\n   * @param successCallback Called when the transaction has completed executing on the database.\n   */\n  transaction(\n    callback: SQLTransactionCallback,\n    errorCallback?: SQLTransactionErrorCallback,\n    successCallback?: () => void\n  ): void;\n\n  readTransaction(\n    callback: SQLTransactionCallback,\n    errorCallback?: SQLTransactionErrorCallback,\n    successCallback?: () => void\n  ): void;\n}\n\n// @docsMissing\nexport type SQLTransactionCallback = (transaction: SQLTransaction) => void;\n\n// @docsMissing\nexport type SQLTransactionErrorCallback = (error: SQLError) => void;\n\n// @needsAudit\n/**\n * A `SQLTransaction` object is passed in as a parameter to the `callback` parameter for the\n * `db.transaction()` method on a `Database` (see above). It allows enqueuing SQL statements to\n * perform in a database transaction.\n */\nexport interface SQLTransaction {\n  /**\n   * Enqueue a SQL statement to execute in the transaction. Authors are strongly recommended to make\n   * use of the `?` placeholder feature of the method to avoid against SQL injection attacks, and to\n   * never construct SQL statements on the fly.\n   * @param sqlStatement A string containing a database query to execute expressed as SQL. The string\n   * may contain `?` placeholders, with values to be substituted listed in the `arguments` parameter.\n   * @param args An array of values (numbers, strings or nulls) to substitute for `?` placeholders in the\n   * SQL statement.\n   * @param callback Called when the query is successfully completed during the transaction. Takes\n   * two parameters: the transaction itself, and a `ResultSet` object (see below) with the results\n   * of the query.\n   * @param errorCallback Called if an error occurred executing this particular query in the\n   * transaction. Takes two parameters: the transaction itself, and the error object.\n   */\n  executeSql(\n    sqlStatement: string,\n    args?: (number | string | null)[],\n    callback?: SQLStatementCallback,\n    errorCallback?: SQLStatementErrorCallback\n  ): void;\n}\n\n// @docsMissing\nexport type SQLStatementCallback = (transaction: SQLTransaction, resultSet: SQLResultSet) => void;\n\n// @docsMissing\nexport type SQLStatementErrorCallback = (transaction: SQLTransaction, error: SQLError) => boolean;\n\n// @needsAudit\nexport type SQLResultSet = {\n  /**\n   * The row ID of the row that the SQL statement inserted into the database, if a row was inserted.\n   */\n  insertId?: number;\n  /**\n   * The number of rows that were changed by the SQL statement.\n   */\n  rowsAffected: number;\n  rows: SQLResultSetRowList;\n};\n\n// @needsAudit\nexport interface SQLResultSetRowList {\n  /**\n   * The number of rows returned by the query.\n   */\n  length: number;\n  /**\n   * Returns the row with the given `index`. If there is no such row, returns `null`.\n   * @param index Index of row to get.\n   */\n  item(index: number): any;\n  /**\n   * The actual array of rows returned by the query. Can be used directly instead of\n   * getting rows through rows.item().\n   */\n  _array: any[];\n}\n\n// @docsMissing\nexport declare class SQLError {\n  static UNKNOWN_ERR: number;\n  static DATABASE_ERR: number;\n  static VERSION_ERR: number;\n  static TOO_LARGE_ERR: number;\n  static QUOTA_ERR: number;\n  static SYNTAX_ERR: number;\n  static CONSTRAINT_ERR: number;\n  static TIMEOUT_ERR: number;\n\n  code: number;\n  message: string;\n}\n\n// @docsMissing\nexport interface WebSQLDatabase extends Database {\n  exec(queries: Query[], readOnly: boolean, callback: SQLiteCallback): void;\n\n  /**\n   * Close the database.\n   */\n  closeAsync(): void;\n\n  /**\n   * Delete the database file.\n   * > The database has to be closed prior to deletion.\n   */\n  deleteAsync(): Promise<void>;\n}\n\n// @docsMissing\nexport type Query = { sql: string; args: unknown[] };\n\n// @docsMissing\nexport type ResultSetError = {\n  error: Error;\n};\n\n// @needsAudit\n/**\n * `ResultSet` objects are returned through second parameter of the `success` callback for the\n * `tx.executeSql()` method on a `SQLTransaction` (see above).\n */\nexport type ResultSet = {\n  /**\n   * The row ID of the row that the SQL statement inserted into the database, if a row was inserted.\n   */\n  insertId?: number;\n  /**\n   * The number of rows that were changed by the SQL statement.\n   */\n  rowsAffected: number;\n  rows: { [column: string]: any }[];\n};\n\n// @docsMissing\nexport type SQLiteCallback = (\n  error?: Error | null,\n  resultSet?: (ResultSetError | ResultSet)[]\n) => void;\n"]}
+{"version":3,"file":"SQLite.types.js","sourceRoot":"","sources":["../src/SQLite.types.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,8CAA8C;AAC9C,gDAAgD;AAChD,2DAA2D;AAC3D,EAAE;AACF,0EAA0E","sourcesContent":["// Definitions copied from `@types/websql` as we want\n// to expose a custom version of the API that:\n// - uses primitive `string` instead of `String`\n// - excludes some methods that are not exposed by our API.\n//\n// Original definitions by: TeamworkGuy2 <https://github.com/TeamworkGuy2>\n\n// @docsMissing\nexport interface Window {\n  openDatabase?: (\n    name: string,\n    version: string,\n    displayName: string,\n    estimatedSize: number,\n    creationCallback?: DatabaseCallback\n  ) => Database;\n}\n\n// @docsMissing\nexport type DatabaseCallback = (database: Database) => void;\n\n// @needsAudit @docsMissing\n/**\n * `Database` objects are returned by calls to `SQLite.openDatabase()`. Such an object represents a\n * connection to a database on your device.\n */\nexport interface Database {\n  version: string;\n\n  /**\n   * Execute a database transaction.\n   * @param callback A function representing the transaction to perform. Takes a Transaction\n   * (see below) as its only parameter, on which it can add SQL statements to execute.\n   * @param errorCallback Called if an error occurred processing this transaction. Takes a single\n   * parameter describing the error.\n   * @param successCallback Called when the transaction has completed executing on the database.\n   */\n  transaction(\n    callback: SQLTransactionCallback,\n    errorCallback?: SQLTransactionErrorCallback,\n    successCallback?: () => void\n  ): void;\n\n  readTransaction(\n    callback: SQLTransactionCallback,\n    errorCallback?: SQLTransactionErrorCallback,\n    successCallback?: () => void\n  ): void;\n}\n\n// @docsMissing\nexport type SQLTransactionCallback = (transaction: SQLTransaction) => void;\n\n// @docsMissing\nexport type SQLTransactionErrorCallback = (error: SQLError) => void;\n\n// @needsAudit\n/**\n * A `SQLTransaction` object is passed in as a parameter to the `callback` parameter for the\n * `db.transaction()` method on a `Database` (see above). It allows enqueuing SQL statements to\n * perform in a database transaction.\n */\nexport interface SQLTransaction {\n  /**\n   * Enqueue a SQL statement to execute in the transaction. Authors are strongly recommended to make\n   * use of the `?` placeholder feature of the method to avoid against SQL injection attacks, and to\n   * never construct SQL statements on the fly.\n   * @param sqlStatement A string containing a database query to execute expressed as SQL. The string\n   * may contain `?` placeholders, with values to be substituted listed in the `arguments` parameter.\n   * @param args An array of values (numbers, strings or nulls) to substitute for `?` placeholders in the\n   * SQL statement.\n   * @param callback Called when the query is successfully completed during the transaction. Takes\n   * two parameters: the transaction itself, and a `ResultSet` object (see below) with the results\n   * of the query.\n   * @param errorCallback Called if an error occurred executing this particular query in the\n   * transaction. Takes two parameters: the transaction itself, and the error object.\n   */\n  executeSql(\n    sqlStatement: string,\n    args?: (number | string | null)[],\n    callback?: SQLStatementCallback,\n    errorCallback?: SQLStatementErrorCallback\n  ): void;\n}\n\n// @docsMissing\nexport type SQLStatementCallback = (transaction: SQLTransaction, resultSet: SQLResultSet) => void;\n\n// @docsMissing\nexport type SQLStatementErrorCallback = (transaction: SQLTransaction, error: SQLError) => boolean;\n\n// @needsAudit\nexport type SQLResultSet = {\n  /**\n   * The row ID of the row that the SQL statement inserted into the database, if a row was inserted.\n   */\n  insertId?: number;\n  /**\n   * The number of rows that were changed by the SQL statement.\n   */\n  rowsAffected: number;\n  rows: SQLResultSetRowList;\n};\n\n// @needsAudit\nexport interface SQLResultSetRowList {\n  /**\n   * The number of rows returned by the query.\n   */\n  length: number;\n  /**\n   * Returns the row with the given `index`. If there is no such row, returns `null`.\n   * @param index Index of row to get.\n   */\n  item(index: number): any;\n  /**\n   * The actual array of rows returned by the query. Can be used directly instead of\n   * getting rows through rows.item().\n   */\n  _array: any[];\n}\n\n// @docsMissing\nexport declare class SQLError {\n  static UNKNOWN_ERR: number;\n  static DATABASE_ERR: number;\n  static VERSION_ERR: number;\n  static TOO_LARGE_ERR: number;\n  static QUOTA_ERR: number;\n  static SYNTAX_ERR: number;\n  static CONSTRAINT_ERR: number;\n  static TIMEOUT_ERR: number;\n\n  code: number;\n  message: string;\n}\n\n/** @deprecated Use `SQLiteDatabase` instead. */\nexport interface WebSQLDatabase extends Database {\n  exec(queries: Query[], readOnly: boolean, callback: SQLiteCallback): void;\n\n  /**\n   * Close the database.\n   */\n  closeAsync(): void;\n\n  /**\n   * Delete the database file.\n   * > The database has to be closed prior to deletion.\n   */\n  deleteAsync(): Promise<void>;\n}\n\n// @docsMissing\nexport type Query = { sql: string; args: unknown[] };\n\n// @docsMissing\nexport interface ResultSetError {\n  error: Error;\n}\n\n// @needsAudit\n/**\n * `ResultSet` objects are returned through second parameter of the `success` callback for the\n * `tx.executeSql()` method on a `SQLTransaction` (see above).\n */\nexport interface ResultSet {\n  /**\n   * The row ID of the row that the SQL statement inserted into the database, if a row was inserted.\n   */\n  insertId?: number;\n  /**\n   * The number of rows that were changed by the SQL statement.\n   */\n  rowsAffected: number;\n  rows: { [column: string]: any }[];\n}\n\n// @docsMissing\nexport type SQLiteCallback = (\n  error?: Error | null,\n  resultSet?: (ResultSetError | ResultSet)[]\n) => void;\n\n/** A transaction object to perform SQL statements in async mode. */\nexport interface SQLTransactionAsync {\n  /** Executes a SQL statement in async mode. */\n  executeSqlAsync(\n    sqlStatement: string,\n    args?: (number | string)[]\n  ): Promise<ResultSetError | ResultSet>;\n}\n\n/** A transaction callback with given `SQLTransactionAsync` object to perform SQL statements in async mode. */\nexport type SQLTransactionAsyncCallback = (transaction: SQLTransactionAsync) => Promise<void>;\n"]}

package/expo-module.config.json

@@ -3,5 +3,8 @@
   "platforms": ["ios", "android"],
   "ios": {
     "modules": ["SQLiteModule"]
+  },
+  "android": {
+    "modules": ["expo.modules.sqlite.SQLiteModule"]
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-sqlite",
-  "version": "11.3.0",
+  "version": "11.3.2",
   "description": "Provides access to a database that can be queried through a WebSQL-like API (https://www.w3.org/TR/webdatabase/). The database is persisted across restarts of your app.",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -44,5 +44,5 @@
   "peerDependencies": {
     "expo": "*"
   },
-  "gitHead": "fa5ecca8251986b9f197cc14074eec0ab6dfb6db"
+  "gitHead": "0d774d352ca6d11f83a3223199c8e5f6ba4c8e09"
 }

package/src/SQLite.ts

@@ -4,7 +4,16 @@ import customOpenDatabase from '@expo/websql/custom';
 import { requireNativeModule } from 'expo-modules-core';
 import { Platform } from 'react-native';
 
-import { Query, ResultSet, ResultSetError, SQLiteCallback, WebSQLDatabase } from './SQLite.types';
+import type {
+  Query,
+  ResultSet,
+  ResultSetError,
+  SQLiteCallback,
+  SQLTransactionAsyncCallback,
+  SQLTransactionAsync,
+  SQLTransactionCallback,
+  SQLTransactionErrorCallback,
+} from './SQLite.types';
 
 const ExpoSQLite = requireNativeModule('ExpoSQLite');
 
@@ -16,7 +25,8 @@ function zipObject(keys: string[], values: any[]) {
   return result;
 }
 
-class SQLiteDatabase {
+/** The database returned by `openDatabase()` */
+export class SQLiteDatabase {
   _name: string;
   _closed: boolean = false;
 
@@ -24,6 +34,9 @@ class SQLiteDatabase {
     this._name = name;
   }
 
+  /**
+   * Executes the SQL statement and returns a callback resolving with the result.
+   */
   exec(queries: Query[], readOnly: boolean, callback: SQLiteCallback): void {
     if (this._closed) {
       throw new Error(`The SQLite database is closed`);
@@ -40,11 +53,39 @@ class SQLiteDatabase {
     );
   }
 
-  close() {
+  /**
+   * Executes the SQL statement and returns a Promise resolving with the result.
+   */
+  async execAsync(queries: Query[], readOnly: boolean): Promise<(ResultSetError | ResultSet)[]> {
+    if (this._closed) {
+      throw new Error(`The SQLite database is closed`);
+    }
+
+    const nativeResultSets = await ExpoSQLite.exec(
+      this._name,
+      queries.map(_serializeQuery),
+      readOnly
+    );
+    return nativeResultSets.map(_deserializeResultSet);
+  }
+
+  /**
+   * @deprecated Use `closeAsync()` instead.
+   */
+  close = this.closeAsync;
+
+  /**
+   * Close the database.
+   */
+  closeAsync(): void {
     this._closed = true;
     return ExpoSQLite.close(this._name);
   }
 
+  /**
+   * Delete the database file.
+   * > The database has to be closed prior to deletion.
+   */
   deleteAsync(): Promise<void> {
     if (!this._closed) {
       throw new Error(
@@ -54,10 +95,60 @@ class SQLiteDatabase {
 
     return ExpoSQLite.deleteAsync(this._name);
   }
+
+  /**
+   * Creates a new transaction with Promise support.
+   * @param asyncCallback A `SQLTransactionAsyncCallback` function that can perform SQL statements in a transaction.
+   * @param readOnly true if all the SQL statements in the callback are read only.
+   */
+  async transactionAsync(
+    asyncCallback: SQLTransactionAsyncCallback,
+    readOnly: boolean = false
+  ): Promise<void> {
+    await this.execAsync([{ sql: 'BEGIN;', args: [] }], false);
+    try {
+      const transaction = new ExpoSQLTransactionAsync(this, readOnly);
+      await asyncCallback(transaction);
+      await this.execAsync([{ sql: 'END;', args: [] }], false);
+    } catch (e: unknown) {
+      await this.execAsync([{ sql: 'ROLLBACK;', args: [] }], false);
+      throw e;
+    }
+  }
+
+  // @ts-expect-error: properties that are added from websql
+  version: string;
+
+  /**
+   * Execute a database transaction.
+   * @param callback A function representing the transaction to perform. Takes a Transaction
+   * (see below) as its only parameter, on which it can add SQL statements to execute.
+   * @param errorCallback Called if an error occurred processing this transaction. Takes a single
+   * parameter describing the error.
+   * @param successCallback Called when the transaction has completed executing on the database.
+   */
+  // @ts-expect-error: properties that are added from websql
+  transaction(
+    callback: SQLTransactionCallback,
+    errorCallback?: SQLTransactionErrorCallback,
+    successCallback?: () => void
+  ): void;
+
+  // @ts-expect-error: properties that are added from websql
+  readTransaction(
+    callback: SQLTransactionCallback,
+    errorCallback?: SQLTransactionErrorCallback,
+    successCallback?: () => void
+  ): void;
 }
 
-function _serializeQuery(query: Query): [string, unknown[]] {
-  return [query.sql, Platform.OS === 'android' ? query.args.map(_escapeBlob) : query.args];
+function _serializeQuery(query: Query): Query | [string, any[]] {
+  return Platform.OS === 'android'
+    ? {
+        sql: query.sql,
+        args: query.args.map(_escapeBlob),
+      }
+    : [query.sql, query.args];
 }
 
 function _deserializeResultSet(nativeResult): ResultSet | ResultSetError {
@@ -109,14 +200,35 @@ export function openDatabase(
   version: string = '1.0',
   description: string = name,
   size: number = 1,
-  callback?: (db: WebSQLDatabase) => void
-): WebSQLDatabase {
+  callback?: (db: SQLiteDatabase) => void
+): SQLiteDatabase {
   if (name === undefined) {
     throw new TypeError(`The database name must not be undefined`);
   }
   const db = _openExpoSQLiteDatabase(name, version, description, size, callback);
   db.exec = db._db.exec.bind(db._db);
-  db.closeAsync = db._db.close.bind(db._db);
+  db.execAsync = db._db.execAsync.bind(db._db);
+  db.closeAsync = db._db.closeAsync.bind(db._db);
   db.deleteAsync = db._db.deleteAsync.bind(db._db);
+  db.transactionAsync = db._db.transactionAsync.bind(db._db);
   return db;
 }
+
+/**
+ * Internal data structure for the async transaction API.
+ * @internal
+ */
+export class ExpoSQLTransactionAsync implements SQLTransactionAsync {
+  constructor(private readonly db: SQLiteDatabase, private readonly readOnly: boolean) {}
+
+  async executeSqlAsync(
+    sqlStatement: string,
+    args?: (number | string)[]
+  ): Promise<ResultSetError | ResultSet> {
+    const resultSets = await this.db.execAsync(
+      [{ sql: sqlStatement, args: args ?? [] }],
+      this.readOnly
+    );
+    return resultSets[0];
+  }
+}

package/src/SQLite.types.ts

@@ -135,7 +135,7 @@ export declare class SQLError {
   message: string;
 }
 
-// @docsMissing
+/** @deprecated Use `SQLiteDatabase` instead. */
 export interface WebSQLDatabase extends Database {
   exec(queries: Query[], readOnly: boolean, callback: SQLiteCallback): void;
 
@@ -155,16 +155,16 @@ export interface WebSQLDatabase extends Database {
 export type Query = { sql: string; args: unknown[] };
 
 // @docsMissing
-export type ResultSetError = {
+export interface ResultSetError {
   error: Error;
-};
+}
 
 // @needsAudit
 /**
  * `ResultSet` objects are returned through second parameter of the `success` callback for the
  * `tx.executeSql()` method on a `SQLTransaction` (see above).
  */
-export type ResultSet = {
+export interface ResultSet {
   /**
    * The row ID of the row that the SQL statement inserted into the database, if a row was inserted.
    */
@@ -174,10 +174,22 @@ export type ResultSet = {
    */
   rowsAffected: number;
   rows: { [column: string]: any }[];
-};
+}
 
 // @docsMissing
 export type SQLiteCallback = (
   error?: Error | null,
   resultSet?: (ResultSetError | ResultSet)[]
 ) => void;
+
+/** A transaction object to perform SQL statements in async mode. */
+export interface SQLTransactionAsync {
+  /** Executes a SQL statement in async mode. */
+  executeSqlAsync(
+    sqlStatement: string,
+    args?: (number | string)[]
+  ): Promise<ResultSetError | ResultSet>;
+}
+
+/** A transaction callback with given `SQLTransactionAsync` object to perform SQL statements in async mode. */
+export type SQLTransactionAsyncCallback = (transaction: SQLTransactionAsync) => Promise<void>;

package/android/src/main/java/expo/modules/sqlite/SQLitePackage.kt

@@ -1,11 +0,0 @@
-package expo.modules.sqlite
-
-import android.content.Context
-import expo.modules.core.BasePackage
-import expo.modules.core.ExportedModule
-
-class SQLitePackage : BasePackage() {
-  override fun createExportedModules(context: Context): List<ExportedModule> {
-    return listOf(SQLiteModule(context))
-  }
-}