@capawesome/capacitor-libsql 0.2.2 → 0.2.3

package/Package.swift

@@ -21,10 +21,6 @@ let package = Package(
                 .product(name: "Cordova", package: "capacitor-swift-pm"),
                 .product(name: "Libsql", package: "libsql-swift")
             ],
-            path: "ios/Plugin"),
-        .testTarget(
-            name: "LibsqlPluginTests",
-            dependencies: ["LibsqlPlugin"],
-            path: "ios/PluginTests")
+            path: "ios/Plugin")
     ]
 )

package/README.md

@@ -1,4 +1,4 @@
-# @capawesome/capacitor-libsql
+# Capacitor libSQL Plugin
 
 Capacitor plugin for [libSQL](https://docs.turso.tech/libsql) databases.[^1]
 
@@ -8,6 +8,15 @@ Capacitor plugin for [libSQL](https://docs.turso.tech/libsql) databases.[^1]
   </a>
 </div>
 
+## Use Cases
+
+The libSQL plugin is typically used whenever an app needs a SQL database, for example:
+
+- **Offline-first apps**: Store data in a local database file on the device and synchronize it with a remote server using the `sync(...)` method.
+- **Remote databases**: Connect directly to a remote libSQL database, such as one hosted on Turso, using a URL and authentication token.
+- **Structured local storage**: Create tables and insert, update, delete, and query data with SQL statements and bound values.
+- **Atomic operations**: Group multiple statements into a transaction that can be committed or rolled back as a whole.
+
 ## Compatibility
 
 | Plugin Version | Capacitor Version | Status         |
@@ -17,6 +26,21 @@ Capacitor plugin for [libSQL](https://docs.turso.tech/libsql) databases.[^1]
 
 ## Installation
 
+You can use our **AI-Assisted Setup** to install the plugin.
+Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command:
+
+```bash
+npx skills add capawesome-team/skills --skill capacitor-plugins
+```
+
+Then use the following prompt:
+
+```
+ Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome/capacitor-libsql` plugin in my project.
+```
+
+If you prefer **Manual Setup**, install the plugin by running the following commands and follow the platform-specific instructions below:
+
 ```bash
 npm install @capawesome/capacitor-libsql
 npx cap sync
@@ -34,6 +58,12 @@ This can be useful if you encounter dependency conflicts with other plugins in y
 
 ## Usage
 
+The following examples show how to connect to local and remote databases, query data, execute insert, update, and delete statements, run statements inside a transaction, and synchronize with a remote server.
+
+### Connect to a local database
+
+Connect to a local database file on the device. If no file exists at the specified path, a new file is created. If neither a path nor a URL is provided, the plugin creates a new in-memory database. This method must be called before any other methods that interact with the database:
+
 ```typescript
 import { Libsql } from '@capawesome/capacitor-libsql';
 
@@ -43,6 +73,14 @@ const connectToLocalDatabase = async () => {
   });
   console.log('Connected to database with ID:', connectionId);
 };
+```
+
+### Connect to a remote database
+
+Connect to a remote libSQL database using its URL and an authentication token:
+
+```typescript
+import { Libsql } from '@capawesome/capacitor-libsql';
 
 const connectToRemoteDatabase = async () => {
   const { connectionId } = await Libsql.connect({
@@ -51,6 +89,14 @@ const connectToRemoteDatabase = async () => {
   });
   console.log('Connected to remote database with ID:', connectionId);
 };
+```
+
+### Query data
+
+Execute a `SELECT` statement and retrieve the result set:
+
+```typescript
+import { Libsql } from '@capawesome/capacitor-libsql';
 
 const query = async () => {
   const result = await Libsql.query({
@@ -59,6 +105,14 @@ const query = async () => {
   });
   console.log('Query result:', result.rows);
 };
+```
+
+### Insert, update, and delete data
+
+Execute any SQL statement, including `INSERT`, `UPDATE`, `DELETE`, and `CREATE TABLE`, optionally with bound values:
+
+```typescript
+import { Libsql } from '@capawesome/capacitor-libsql';
 
 const execute = async () => {
   await Libsql.execute({
@@ -68,6 +122,14 @@ const execute = async () => {
   });
   console.log('Insert executed successfully');
 };
+```
+
+### Run multiple statements in a transaction
+
+Begin a transaction, execute statements as part of it, and either commit or roll back all changes. Transactions are only available on Android:
+
+```typescript
+import { Libsql } from '@capawesome/capacitor-libsql';
 
 const performTransaction = async () => {
   const { transactionId } = await Libsql.beginTransaction({
@@ -93,6 +155,14 @@ const performTransaction = async () => {
     console.error('Transaction rolled back due to error:', error);
   }
 };
+```
+
+### Synchronize with a remote server
+
+Synchronize the database with the remote server:
+
+```typescript
+import { Libsql } from '@capawesome/capacitor-libsql';
 
 const sync = async () => {
   await Libsql.sync({
@@ -385,4 +455,39 @@ Available on iOS and Android.
 
 </docgen-api>
 
+## FAQ
+
+### Can I use this plugin with Turso?
+
+Yes, you can connect to a remote libSQL database hosted on [Turso](https://docs.turso.tech/libsql) by passing the database URL and an authentication token to the `connect(...)` method, as shown in the [usage example](#connect-to-a-remote-database) above.
+
+### Do I need a remote database to use this plugin?
+
+No, the plugin also works with purely local databases. If you pass a `path` to the `connect(...)` method, the plugin uses a database file on the device and creates it if it does not exist. If you provide neither a path nor a URL, the plugin creates a new in-memory database.
+
+### Are transactions supported?
+
+Yes, you can use the `beginTransaction(...)`, `commitTransaction(...)` and `rollbackTransaction(...)` methods to group multiple statements into a transaction. Note that transactions are only available on Android.
+
+### What is the difference between the `query` and `execute` methods?
+
+The `query(...)` method is used to execute `SELECT` statements and retrieve the result set. The `execute(...)` method is used for any other SQL statement, including `INSERT`, `UPDATE`, `DELETE`, and `CREATE TABLE`, and does not return a result set. Both methods support binding values to the statement.
+
+### How do I keep a local database in sync with a remote server?
+
+Call the `sync(...)` method with the ID of the connection you want to synchronize. This synchronizes the database with the remote server and is available on Android and iOS.
+
+### Can I use this plugin with Ionic, React, Vue or Angular?
+
+Yes, the plugin is framework-agnostic. It works in any Capacitor app regardless of the web framework, including Ionic with Angular, React, or Vue, as well as plain JavaScript projects.
+
+## Related Plugins
+
+- [Secure Preferences](https://capawesome.io/docs/sdks/capacitor/secure-preferences/): Securely store key/value pairs such as passwords or tokens.
+- [SQLite](https://capawesome.io/docs/sdks/capacitor/sqlite/): Access SQLite databases with support for encryption, transactions, and schema migrations.
+
+## Newsletter
+
+Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/).
+
 [^1]: This project is not affiliated with, endorsed by, sponsored by, or approved by CHISELSTRIKE INC. or any of their affiliates or subsidiaries.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@capawesome/capacitor-libsql",
-  "version": "0.2.2",
-  "description": "Capacitor plugin for libSQL databases.",
+  "version": "0.2.3",
+  "description": "Capacitor plugin for libSQL databases on Android and iOS.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
   "types": "dist/esm/index.d.ts",
@@ -32,11 +32,20 @@
       "url": "https://opencollective.com/capawesome"
     }
   ],
-  "homepage": "https://capawesome.io/plugins/libsql/",
+  "homepage": "https://capawesome.io/docs/sdks/capacitor/libsql/",
   "keywords": [
     "capacitor",
     "plugin",
-    "native"
+    "native",
+    "capacitor-plugin",
+    "libsql",
+    "turso",
+    "sqlite",
+    "sql database",
+    "local database",
+    "remote database",
+    "database sync",
+    "offline-first"
   ],
   "scripts": {
     "verify": "npm run verify:ios && npm run verify:android && npm run verify:web",
@@ -57,24 +66,21 @@
   },
   "devDependencies": {
     "@capacitor/android": "8.0.0",
-    "@capacitor/cli": "8.0.0",
+    "@capacitor/cli": "8.4.2",
     "@capacitor/core": "8.0.0",
     "@capacitor/docgen": "0.3.1",
     "@capacitor/ios": "8.0.0",
     "@ionic/eslint-config": "0.4.0",
-    "@ionic/swiftlint-config": "2.0.0",
     "eslint": "8.57.0",
-    "prettier": "3.4.2",
-    "prettier-plugin-java": "2.6.7",
+    "prettier-plugin-java": "2.9.7",
     "rimraf": "6.1.2",
-    "rollup": "4.53.3",
+    "rollup": "4.62.3",
     "swiftlint": "2.0.0",
     "typescript": "5.9.3"
   },
   "peerDependencies": {
     "@capacitor/core": ">=8.0.0"
   },
-  "swiftlint": "@ionic/swiftlint-config",
   "eslintConfig": {
     "extends": "@ionic/eslint-config/recommended"
   },