@capawesome/capacitor-libsql 0.1.0

package/Package.swift

@@ -0,0 +1,30 @@
+// swift-tools-version: 5.9
+import PackageDescription
+
+let package = Package(
+    name: "CapawesomeCapacitorLibsql",
+    platforms: [.iOS(.v14)],
+    products: [
+        .library(
+            name: "CapawesomeCapacitorLibsql",
+            targets: ["LibsqlPlugin"])
+    ],
+    dependencies: [
+        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "7.0.0"),
+        .package(url: "https://github.com/tursodatabase/libsql-swift", from: "0.1.1")
+    ],
+    targets: [
+        .target(
+            name: "LibsqlPlugin",
+            dependencies: [
+                .product(name: "Capacitor", package: "capacitor-swift-pm"),
+                .product(name: "Cordova", package: "capacitor-swift-pm"),
+                .product(name: "Libsql", package: "libsql-swift")
+            ],
+            path: "ios/Plugin"),
+        .testTarget(
+            name: "LibsqlPluginTests",
+            dependencies: ["LibsqlPlugin"],
+            path: "ios/PluginTests")
+    ]
+)

package/README.md

@@ -0,0 +1,301 @@
+# @capawesome/capacitor-libsql
+
+Capacitor plugin for libSQL databases.
+
+## Installation
+
+```bash
+npm install @capawesome/capacitor-libsql
+npx cap sync
+```
+
+## Usage
+
+```typescript
+import { Libsql } from '@capawesome/capacitor-libsql';
+
+const echo = async () => {
+  await Libsql.echo();
+};
+```
+
+## API
+
+<docgen-index>
+
+* [`beginTransaction(...)`](#begintransaction)
+* [`commitTransaction(...)`](#committransaction)
+* [`connect(...)`](#connect)
+* [`execute(...)`](#execute)
+* [`executeBatch(...)`](#executebatch)
+* [`query(...)`](#query)
+* [`rollbackTransaction(...)`](#rollbacktransaction)
+* [`sync(...)`](#sync)
+* [Interfaces](#interfaces)
+* [Type Aliases](#type-aliases)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### beginTransaction(...)
+
+```typescript
+beginTransaction(options: BeginTransactionOptions) => Promise<BeginTransactionResult>
+```
+
+Begin a transaction on the specified database connection.
+
+Only available on Android.
+
+| Param         | Type                                                                        |
+| ------------- | --------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#begintransactionoptions">BeginTransactionOptions</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#begintransactionresult">BeginTransactionResult</a>&gt;</code>
+
+**Since:** 0.0.0
+
+--------------------
+
+
+### commitTransaction(...)
+
+```typescript
+commitTransaction(options: CommitTransactionOptions) => Promise<void>
+```
+
+Commit the current transaction on the specified database connection.
+
+Only available on Android.
+
+| Param         | Type                                                                          |
+| ------------- | ----------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#committransactionoptions">CommitTransactionOptions</a></code> |
+
+**Since:** 0.0.0
+
+--------------------
+
+
+### connect(...)
+
+```typescript
+connect(options: ConnectOptions) => Promise<ConnectResult>
+```
+
+Connect to a database.
+
+This method must be called before any other methods that interact with the database.
+
+| Param         | Type                                                      |
+| ------------- | --------------------------------------------------------- |
+| **`options`** | <code><a href="#connectoptions">ConnectOptions</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#connectresult">ConnectResult</a>&gt;</code>
+
+**Since:** 0.0.0
+
+--------------------
+
+
+### execute(...)
+
+```typescript
+execute(options: ExecuteOptions) => Promise<void>
+```
+
+Execute a single SQL statement on the specified database connection.
+
+This method can be used to execute any SQL statement, including `INSERT`, `UPDATE`, `DELETE`, and `CREATE TABLE`.
+
+| Param         | Type                                                      |
+| ------------- | --------------------------------------------------------- |
+| **`options`** | <code><a href="#executeoptions">ExecuteOptions</a></code> |
+
+**Since:** 0.0.0
+
+--------------------
+
+
+### executeBatch(...)
+
+```typescript
+executeBatch(options: ExecuteBatchOptions) => Promise<void>
+```
+
+Execute a batch of SQL statements on the specified database connection.
+
+This method can be used to execute multiple SQL statements in a single call.
+
+| Param         | Type                                                                |
+| ------------- | ------------------------------------------------------------------- |
+| **`options`** | <code><a href="#executebatchoptions">ExecuteBatchOptions</a></code> |
+
+**Since:** 0.0.0
+
+--------------------
+
+
+### query(...)
+
+```typescript
+query(options: QueryOptions) => Promise<QueryResult>
+```
+
+Query the database and return the result set.
+
+This method can be used to execute `SELECT` statements and retrieve the result set.
+
+| Param         | Type                                                  |
+| ------------- | ----------------------------------------------------- |
+| **`options`** | <code><a href="#queryoptions">QueryOptions</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#queryresult">QueryResult</a>&gt;</code>
+
+**Since:** 0.0.0
+
+--------------------
+
+
+### rollbackTransaction(...)
+
+```typescript
+rollbackTransaction(options: RollbackTransactionOptions) => Promise<void>
+```
+
+Rollback the current transaction on the specified database connection.
+
+This method will undo all changes made in the current transaction.
+
+Only available on Android.
+
+| Param         | Type                                                                              |
+| ------------- | --------------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#rollbacktransactionoptions">RollbackTransactionOptions</a></code> |
+
+**Since:** 0.0.0
+
+--------------------
+
+
+### sync(...)
+
+```typescript
+sync(options: SyncOptions) => Promise<void>
+```
+
+Synchronize the database with the remote server.
+
+Only available on iOS.
+
+| Param         | Type                                                |
+| ------------- | --------------------------------------------------- |
+| **`options`** | <code><a href="#syncoptions">SyncOptions</a></code> |
+
+**Since:** 0.0.0
+
+--------------------
+
+
+### Interfaces
+
+
+#### BeginTransactionResult
+
+| Prop                | Type                | Description                                 | Since |
+| ------------------- | ------------------- | ------------------------------------------- | ----- |
+| **`transactionId`** | <code>string</code> | The ID of the transaction that was started. | 0.0.0 |
+
+
+#### BeginTransactionOptions
+
+| Prop               | Type                | Description                                           | Since |
+| ------------------ | ------------------- | ----------------------------------------------------- | ----- |
+| **`connectionId`** | <code>string</code> | The ID of the connection to begin the transaction on. | 0.0.0 |
+
+
+#### CommitTransactionOptions
+
+| Prop                | Type                | Description                                            | Since |
+| ------------------- | ------------------- | ------------------------------------------------------ | ----- |
+| **`connectionId`**  | <code>string</code> | The ID of the connection to commit the transaction on. | 0.0.0 |
+| **`transactionId`** | <code>string</code> | The ID of the transaction to commit.                   | 0.0.0 |
+
+
+#### ConnectResult
+
+| Prop               | Type                | Description               | Since |
+| ------------------ | ------------------- | ------------------------- | ----- |
+| **`connectionId`** | <code>string</code> | The ID of the connection. | 0.0.0 |
+
+
+#### ConnectOptions
+
+| Prop            | Type                | Description                                                                                                                                                                                                               | Since |
+| --------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
+| **`authToken`** | <code>string</code> | The authentication token for the database. This is required for connecting to a remote database. If the database is local (i.e., a file on the device), this can be omitted.                                              | 0.0.0 |
+| **`path`**      | <code>string</code> | The path to the database file. If no path or URL is provided, the plugin will create a new in-memory database. If no file exists at the specified path, a new file will be created.                                       | 0.0.0 |
+| **`url`**       | <code>string</code> | The URL of the database. This can be used to connect to a remote database. If the URL is provided, the `authToken` must also be provided. If no path or URL is provided, the plugin will create a new in-memory database. | 0.0.0 |
+
+
+#### ExecuteOptions
+
+| Prop                | Type                 | Description                                                                 | Since |
+| ------------------- | -------------------- | --------------------------------------------------------------------------- | ----- |
+| **`connectionId`**  | <code>string</code>  | The ID of the connection to execute the SQL statement on.                   | 0.0.0 |
+| **`statement`**     | <code>string</code>  | The SQL statement to execute.                                               | 0.0.0 |
+| **`transactionId`** | <code>string</code>  | The transaction ID to use for the SQL statement. Only available on Android. | 0.0.0 |
+| **`values`**        | <code>Value[]</code> | The values to bind to the SQL statement.                                    | 0.0.0 |
+
+
+#### ExecuteBatchOptions
+
+| Prop               | Type                   | Description                                                         | Since |
+| ------------------ | ---------------------- | ------------------------------------------------------------------- | ----- |
+| **`connectionId`** | <code>string</code>    | The ID of the connection to execute the batch on.                   | 0.0.0 |
+| **`statement`**    | <code>string[]</code>  | The SQL statements to execute in the batch.                         | 0.0.0 |
+| **`values`**       | <code>Value[][]</code> | The transaction ID to use for the batch. Only available on Android. | 0.0.0 |
+
+
+#### QueryResult
+
+| Prop       | Type                   | Description                       | Since |
+| ---------- | ---------------------- | --------------------------------- | ----- |
+| **`rows`** | <code>Value[][]</code> | The values returned by the query. | 0.0.0 |
+
+
+#### QueryOptions
+
+| Prop                | Type                 | Description                                                         | Since |
+| ------------------- | -------------------- | ------------------------------------------------------------------- | ----- |
+| **`connectionId`**  | <code>string</code>  | The ID of the connection to query.                                  | 0.0.0 |
+| **`statement`**     | <code>string</code>  | The SQL statement to execute.                                       | 0.0.0 |
+| **`transactionId`** | <code>string</code>  | The transaction ID to use for the query. Only available on Android. | 0.0.0 |
+| **`values`**        | <code>Value[]</code> | The values to bind to the SQL statement.                            | 0.0.0 |
+
+
+#### RollbackTransactionOptions
+
+| Prop                | Type                | Description                                              | Since |
+| ------------------- | ------------------- | -------------------------------------------------------- | ----- |
+| **`connectionId`**  | <code>string</code> | The ID of the connection to rollback the transaction on. | 0.0.0 |
+| **`transactionId`** | <code>string</code> | The ID of the transaction to rollback.                   | 0.0.0 |
+
+
+#### SyncOptions
+
+| Prop               | Type                | Description                       | Since |
+| ------------------ | ------------------- | --------------------------------- | ----- |
+| **`connectionId`** | <code>string</code> | The ID of the connection to sync. | 0.0.0 |
+
+
+### Type Aliases
+
+
+#### Value
+
+<code>string | number | null</code>
+
+</docgen-api>

package/android/build.gradle

@@ -0,0 +1,66 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.0'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.2.1'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.6.1'
+    libsqlVersion = project.hasProperty('libsqlVersion') ? rootProject.ext.libsqlVersion : '0.1.0'
+}
+
+buildscript {
+    ext.kotlin_version = project.hasProperty("kotlin_version") ? rootProject.ext.kotlin_version : '1.9.25'
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.7.2'
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+    }
+}
+
+apply plugin: 'com.android.library'
+apply plugin: 'org.jetbrains.kotlin.android'
+
+android {
+    namespace "io.capawesome.capacitorjs.plugins.libsql"
+    compileSdk project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 35
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 23
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 35
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_21
+        targetCompatibility JavaVersion.VERSION_21
+    }
+    kotlinOptions {
+        jvmTarget = '21'
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    implementation "tech.turso.libsql:libsql:$libsqlVersion"
+    testImplementation "junit:junit:$junitVersion"
+    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,2 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+</manifest>

package/android/src/main/java/io/capawesome/capacitorjs/plugins/libsql/Libsql.kt

@@ -0,0 +1,188 @@
+package io.capawesome.capacitorjs.plugins.libsql
+
+import io.capawesome.capacitorjs.plugins.libsql.classes.options.*
+import io.capawesome.capacitorjs.plugins.libsql.classes.results.*
+import io.capawesome.capacitorjs.plugins.libsql.interfaces.*
+import tech.turso.libsql.Database
+import java.io.File
+import tech.turso.libsql.Connection as LibsqlConnection
+import java.util.concurrent.ConcurrentHashMap
+import java.util.UUID
+
+class Libsql(private val plugin: LibsqlPlugin) {
+    
+    private val databases = ConcurrentHashMap<String, Database>()
+    private val connections = ConcurrentHashMap<String, LibsqlConnection>()
+    private val transactions = ConcurrentHashMap<String, String>()
+
+    @Throws(Exception::class)
+    fun connect(options: ConnectOptions, callback: NonEmptyResultCallback<ConnectResult>) {
+        try {
+            val connectionId = UUID.randomUUID().toString()
+            
+            val database = when {
+                options.url != null && options.path != null -> {
+                    // Embedded replica mode
+                    tech.turso.libsql.Libsql.open(
+                        url = options.url!!,
+                        authToken = options.authToken!!,
+                        path = resolvePath(options.path!!)
+                    )
+                }
+                options.url != null -> {
+                    // Remote-only mode
+                    tech.turso.libsql.Libsql.open(
+                        url = options.url!!,
+                        authToken = options.authToken!!
+                    )
+                }
+                options.path != null -> {
+                    // Local-only mode
+                    tech.turso.libsql.Libsql.open(path = resolvePath(options.path!!))
+                }
+                else -> {
+                    // In-memory database
+                    tech.turso.libsql.Libsql.open(path = ":memory:")
+                }
+            }
+
+            val connection = database.connect()
+            
+            databases[connectionId] = database
+            connections[connectionId] = connection
+
+            val result = ConnectResult(connectionId)
+            callback.success(result)
+        } catch (exception: Exception) {
+            callback.error(exception)
+        }
+    }
+
+    @Throws(Exception::class)
+    fun execute(options: ExecuteOptions, callback: EmptyCallback) {
+        try {
+            val connection = connections[options.connectionId]
+                ?: throw Exception("Connection not found: ${options.connectionId}")
+
+            val values = options.values?.toTypedArray()
+            
+            if (values != null && values.isNotEmpty()) {
+                connection.execute(options.statement, *values)
+            } else {
+                connection.execute(options.statement)
+            }
+
+            callback.success()
+        } catch (exception: Exception) {
+            callback.error(exception)
+        }
+    }
+
+    @Throws(Exception::class)
+    fun executeBatch(options: ExecuteBatchOptions, callback: EmptyCallback) {
+        try {
+            val connection = connections[options.connectionId]
+                ?: throw Exception("Connection not found: ${options.connectionId}")
+
+            for (i in options.statement.indices) {
+                val statement = options.statement[i]
+                val values = options.values?.getOrNull(i)?.toTypedArray()
+                
+                if (!values.isNullOrEmpty()) {
+                    connection.execute(statement, *values)
+                } else {
+                    connection.execute(statement)
+                }
+            }
+
+            callback.success()
+        } catch (exception: Exception) {
+            callback.error(exception)
+        }
+    }
+
+    @Throws(Exception::class)
+    fun query(options: QueryOptions, callback: NonEmptyResultCallback<QueryResult>) {
+        try {
+            val connection = connections[options.connectionId]
+                ?: throw Exception("Connection not found: ${options.connectionId}")
+
+            val values = options.values?.toTypedArray()
+            
+            val rows = if (values != null && values.isNotEmpty()) {
+                connection.query(options.statement, *values)
+            } else {
+                connection.query(options.statement)
+            }
+
+            val result = QueryResult(rows)
+            callback.success(result)
+        } catch (exception: Exception) {
+            callback.error(exception)
+        }
+    }
+
+    @Throws(Exception::class)
+    fun beginTransaction(options: BeginTransactionOptions, callback: NonEmptyResultCallback<BeginTransactionResult>) {
+        try {
+            val connection = connections[options.connectionId]
+                ?: throw Exception("Connection not found: ${options.connectionId}")
+
+            connection.execute("BEGIN TRANSACTION")
+            
+            val transactionId = UUID.randomUUID().toString()
+            transactions[transactionId] = options.connectionId
+
+            val result = BeginTransactionResult(transactionId)
+            callback.success(result)
+        } catch (exception: Exception) {
+            callback.error(exception)
+        }
+    }
+
+    @Throws(Exception::class)
+    fun commitTransaction(options: CommitTransactionOptions, callback: EmptyCallback) {
+        try {
+            val connection = connections[options.connectionId]
+                ?: throw Exception("Connection not found: ${options.connectionId}")
+
+            if (!transactions.containsKey(options.transactionId)) {
+                throw Exception("Transaction not found: ${options.transactionId}")
+            }
+
+            connection.execute("COMMIT")
+            transactions.remove(options.transactionId)
+
+            callback.success()
+        } catch (exception: Exception) {
+            callback.error(exception)
+        }
+    }
+
+    @Throws(Exception::class)
+    fun rollbackTransaction(options: RollbackTransactionOptions, callback: EmptyCallback) {
+        try {
+            val connection = connections[options.connectionId]
+                ?: throw Exception("Connection not found: ${options.connectionId}")
+
+            if (!transactions.containsKey(options.transactionId)) {
+                throw Exception("Transaction not found: ${options.transactionId}")
+            }
+
+            connection.execute("ROLLBACK")
+            transactions.remove(options.transactionId)
+
+            callback.success()
+        } catch (exception: Exception) {
+            callback.error(exception)
+        }
+    }
+
+    private fun resolvePath(path: String): String {
+        var file = File(path)
+        if (!file.isAbsolute) {
+            file = File(plugin.context.getDatabasePath(path).absolutePath)
+        }
+        return file.absolutePath
+    }
+}