@capacitor-community/sqlite 5.0.7-2 → 5.0.8

package/README.md

@@ -18,7 +18,7 @@
   <a href="https://www.npmjs.com/package/@capacitor-community/sqlite"><img src="https://img.shields.io/npm/dw/@capacitor-community/sqlite?style=flat-square" /></a>
   <a href="https://www.npmjs.com/package/@capacitor-community/sqlite"><img src="https://img.shields.io/npm/v/@capacitor-community/sqlite?style=flat-square" /></a>
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-<a href="#contributors-"><img src="https://img.shields.io/badge/all%20contributors-36-orange?style=flat-square" /></a>
+<a href="#contributors-"><img src="https://img.shields.io/badge/all%20contributors-37-orange?style=flat-square" /></a>
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 </p>
 
@@ -75,7 +75,7 @@ const config: CapacitorConfig = {
         biometricTitle : "Biometric login for capacitor sqlite",
         biometricSubTitle : "Log in using your biometric"
       },
-      electronIsEncryption: false,
+      electronIsEncryption: true,
       electronWindowsLocation: "C:\\ProgramData\\CapacitorDatabases",
       electronMacLocation: "/Volumes/Development_Lacie/Development/Databases",
       electronLinuxLocation: "Databases"
@@ -96,6 +96,12 @@ export default config;
  - [Datatypes In SQLite Version 3](https://www.sqlite.org/datatype3.html)
  - [IncrementalUpgradeDatabaseVersion](https://capacitorjs.com/docs/IncrementalUpgradeDatabaseVersion.md)
 
+
+## Tutorials Blog
+
+ - [JeepQ Capacitor Plugin Tutorials](https://jepiqueau.github.io/)
+
+
 ## Web Quirks
 
 The plugin follows the guidelines from the `Capacitor Team`,
@@ -176,6 +182,7 @@ npm install --save crypto-js
 npm install --save-dev @types/better-sqlite3
 npm install --save-dev @types/electron-json-storage
 npm install --save-dev @types/crypto-js
+npm install --save-dev electron-builder@24.6.3
 ```
 - **Important**: `node-fetch` version must be `<=2.6.7`; otherwise [you'll get an error](https://github.com/capacitor-community/sqlite/issues/349 "you'll get an error ERR_REQUIRE_ESM") running the app. 
 
@@ -242,6 +249,10 @@ npm install --save-dev @types/crypto-js
 | isInConfigBiometricAuth     | ✅      | ✅  | ❌        | ❌  | since 4.6.2-2
 | getFromLocalDiskToStore     | ❌      | ❌  | ❌        | ✅  | since 4.6.3
 | saveToLocalDisk             | ❌      | ❌  | ❌        | ✅  | since 4.6.3
+| beginTransaction            | ✅      | ✅  | ✅        | ✅  | since 5.0.7
+| commitTransaction           | ✅      | ✅  | ✅        | ✅  | since 5.0.7
+| rollbackTransaction         | ✅      | ✅  | ✅        | ✅  | since 5.0.7
+| isTransactionActive         | ✅      | ✅  | ✅        | ✅  | since 5.0.7
 
 
 ## Documentation & APIs
@@ -270,6 +281,9 @@ npm install --save-dev @types/crypto-js
 
 - [Electron Better SQLite3](https://github.com/capacitor-community/sqlite/blob/master/docs/ElectronBetterSQLite3.md)
 
+- [Enable minified build on Android](https://github.com/capacitor-community/sqlite/blob/master/docs/AndroidMinify.md)
+
+
 ## Applications demonstrating the use of the plugin and related documentation
 
 ### Ionic/Angular
@@ -374,6 +388,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
   <a href="https://github.com/pranav-singhal" title="pranav-singhal"><img src="https://github.com/pranav-singhal.png?size=100" width="50" height="50" /></a>
   <a href="https://github.com/beligatclement" title="beligatclement"><img src="https://github.com/beligatclement.png?size=100" width="50" height="50" /></a>
   <a href="https://github.com/cosentino" title="cosentino"><img src="https://avatars.githubusercontent.com/u/376903?s=48&v=4" width="50" height="50" /></a>
+  <a href="https://github.com/Guiqft" title="cosentino"><img src="https://avatars.githubusercontent.com/u/9392803?v=4" width="50" height="50" /></a>
 </p>
 
 

package/android/src/main/java/com/getcapacitor/community/database/sqlite/CapacitorSQLite.java

@@ -451,6 +451,128 @@ public class CapacitorSQLite {
             throw new Exception(msg);
         }
     }
+    /**
+     * BeginTransaction
+     *
+     * @param dbName Database name
+     * @return JSObject changes
+     * @throws Exception message
+     */
+    public JSObject beginTransaction(String dbName) throws Exception {
+        JSObject retObj = new JSObject();
+        dbName = getDatabaseName(dbName);
+        String connName = "RW_" + dbName;
+        Database db = dbDict.get(connName);
+        if (db != null) {
+            if (!db.isNCDB() && db.isOpen()) {
+                try {
+                    Integer res =  db.beginTransaction();
+                    retObj.put("changes", res);
+                    return retObj;
+                } catch (Exception e) {
+                    throw new Exception(e.getMessage());
+                }
+            } else {
+                String msg = "database " + dbName + " not opened";
+                throw new Exception(msg);
+            }
+        } else {
+            String msg = "No available connection for database " + dbName;
+            throw new Exception(msg);
+        }
+    }
+
+    /**
+     * CommitTransaction
+     *
+     * @param dbName Database name
+     * @return JSObject changes
+     * @throws Exception message
+     */
+    public JSObject commitTransaction(String dbName) throws Exception {
+        JSObject retObj = new JSObject();
+        dbName = getDatabaseName(dbName);
+        String connName = "RW_" + dbName;
+        Database db = dbDict.get(connName);
+        if (db != null) {
+            if (!db.isNCDB() && db.isOpen()) {
+                try {
+                    Integer res =  db.commitTransaction();
+                    retObj.put("changes", res);
+                    return retObj;
+                } catch (Exception e) {
+                    throw new Exception(e.getMessage());
+                }
+            } else {
+                String msg = "database " + dbName + " not opened";
+                throw new Exception(msg);
+            }
+        } else {
+            String msg = "No available connection for database " + dbName;
+            throw new Exception(msg);
+        }
+    }
+
+    /**
+     * Rollback Transaction
+     *
+     * @param dbName Database name
+     * @return JSObject changes
+     * @throws Exception message
+     */
+    public JSObject rollbackTransaction(String dbName) throws Exception {
+        JSObject retObj = new JSObject();
+        dbName = getDatabaseName(dbName);
+        String connName = "RW_" + dbName;
+        Database db = dbDict.get(connName);
+        if (db != null) {
+            if (!db.isNCDB() && db.isOpen()) {
+                try {
+                    Integer res =  db.rollbackTransaction();
+                    retObj.put("changes", res);
+                    return retObj;
+                } catch (Exception e) {
+                    throw new Exception(e.getMessage());
+                }
+            } else {
+                String msg = "database " + dbName + " not opened";
+                throw new Exception(msg);
+            }
+        } else {
+            String msg = "No available connection for database " + dbName;
+            throw new Exception(msg);
+        }
+    }
+
+    /**
+     * IsTransactionActive
+     *
+     * @param dbName database name
+     * @return Boolean
+     * @throws Exception message
+     */
+    public Boolean isTransactionActive(String dbName) throws Exception {
+        dbName = getDatabaseName(dbName);
+        String connName = "RW_" + dbName;
+        Database db = dbDict.get(connName);
+        if (db != null) {
+            if (!db.isNCDB() && db.isOpen()) {
+                try {
+                    boolean res = db.isAvailTrans();
+                    return res;
+                } catch (Exception e) {
+                    throw new Exception(e.getMessage());
+                }
+
+            } else {
+                String msg = "database " + dbName + " not opened";
+                throw new Exception(msg);
+            }
+        } else {
+            String msg = "No available connection for database " + dbName;
+            throw new Exception(msg);
+        }
+    }
 
     /**
      * GetUrl
@@ -846,7 +968,7 @@ public class CapacitorSQLite {
                     }
                 } else {
                     try {
-                        res = db.runSQL(statement, null, transaction, returnMode);
+                        res = db.runSQL(statement, new ArrayList<>(), transaction, returnMode);
                         return res;
                     } catch (Exception e) {
                         throw new Exception(e.getMessage());
@@ -1147,7 +1269,8 @@ public class CapacitorSQLite {
         }
     }
 
-    public JSObject exportToJson(String dbName, String expMode, Boolean readonly) throws Exception {
+    public JSObject exportToJson(String dbName, String expMode,
+                                 Boolean readonly, Boolean encrypted) throws Exception {
         dbName = getDatabaseName(dbName);
         String connName = readonly ? "RO_" + dbName : "RW_" + dbName;
         Database db = dbDict.get(connName);
@@ -1157,7 +1280,7 @@ public class CapacitorSQLite {
                     String msg = "ExportToJson: db not opened";
                     throw new Exception(msg);
                 }
-                JSObject ret = db.exportToJson(expMode);
+                JSObject ret = db.exportToJson(expMode, encrypted);
                 if (ret.length() == 0) {
                     String msg = "ExportToJson: : return Object is empty " + "No data to synchronize";
                     throw new Exception(msg);

package/android/src/main/java/com/getcapacitor/community/database/sqlite/CapacitorSQLitePlugin.java

@@ -369,7 +369,119 @@ public class CapacitorSQLitePlugin extends Plugin {
             rHandler.retResult(call, null, loadMessage);
         }
     }
+    /**
+     * BeginTransaction Method
+     * Begin a Database Transaction
+     *
+     * @param call PluginCall
+     */
+    @PluginMethod
+    public void beginTransaction(PluginCall call) {
+        JSObject retRes = new JSObject();
+        retRes.put("changes", Integer.valueOf(-1));
+        if (!call.getData().has("database")) {
+            String msg = "BeginTransaction: Must provide a database name";
+            rHandler.retChanges(call, retRes, msg);
+            return;
+        }
+        String dbName = call.getString("database");
+
+        if (implementation != null) {
+            try {
+                JSObject res = implementation.beginTransaction(dbName);
+                rHandler.retChanges(call, res, null);
+            } catch (Exception e) {
+                String msg = "BeginTransaction: " + e.getMessage();
+                rHandler.retChanges(call, retRes, msg);
+            }
+        } else {
+            rHandler.retChanges(call, retRes, loadMessage);
+        }
+    }
+    /**
+     * CommitTransaction Method
+     * Commit a Database Transaction
+     *
+     * @param call PluginCall
+     */
+    @PluginMethod
+    public void commitTransaction(PluginCall call) {
+        JSObject retRes = new JSObject();
+        retRes.put("changes", Integer.valueOf(-1));
+        if (!call.getData().has("database")) {
+            String msg = "CommitTransaction: Must provide a database name";
+            rHandler.retChanges(call, retRes, msg);
+            return;
+        }
+        String dbName = call.getString("database");
+
+        if (implementation != null) {
+            try {
+                JSObject res = implementation.commitTransaction(dbName);
+                rHandler.retChanges(call, res, null);
+            } catch (Exception e) {
+                String msg = "CommitTransaction: " + e.getMessage();
+                rHandler.retChanges(call, retRes, msg);
+            }
+        } else {
+            rHandler.retChanges(call, retRes, loadMessage);
+        }
+    }
 
+    /**
+     * RollbackTransaction Method
+     * Rollbact a Database Transaction
+     *
+     * @param call PluginCall
+     */
+    @PluginMethod
+    public void rollbackTransaction(PluginCall call) {
+        JSObject retRes = new JSObject();
+        retRes.put("changes", Integer.valueOf(-1));
+        if (!call.getData().has("database")) {
+            String msg = "RollbackTransaction: Must provide a database name";
+            rHandler.retChanges(call, retRes, msg);
+            return;
+        }
+        String dbName = call.getString("database");
+
+        if (implementation != null) {
+            try {
+                JSObject res = implementation.rollbackTransaction(dbName);
+                rHandler.retChanges(call, res, null);
+            } catch (Exception e) {
+                String msg = "RollbackTransaction: " + e.getMessage();
+                rHandler.retChanges(call, retRes, msg);
+            }
+        } else {
+            rHandler.retChanges(call, retRes, loadMessage);
+        }
+    }
+    /**
+     * IsTransactionActive Method
+     * Check if a Database Transaction is Active
+     *
+     * @param call PluginCall
+     */
+    @PluginMethod
+    public void isTransactionActive(PluginCall call) {
+        if (!call.getData().has("database")) {
+            rHandler.retResult(call, null, "Must provide a database name");
+            return;
+        }
+        String dbName = call.getString("database");
+        if (implementation != null) {
+            try {
+                Boolean res = implementation.isTransactionActive(dbName);
+                rHandler.retResult(call, res, null);
+            } catch (Exception e) {
+                String msg = "IsTransactionActive: " + e.getMessage();
+                rHandler.retResult(call, null, msg);
+            }
+        } else {
+            rHandler.retResult(call, null, loadMessage);
+        }
+    }
     /**
      * GetUrl Method
      * Get a database Url
@@ -1336,10 +1448,12 @@ public class CapacitorSQLitePlugin extends Plugin {
             return;
         }
         Boolean readOnly = call.getBoolean("readonly", false);
+        Boolean encrypted = call.getBoolean("encrypted", false);
 
         if (implementation != null) {
             try {
-                JSObject res = implementation.exportToJson(dbName, expMode, readOnly);
+                JSObject res = implementation.exportToJson(dbName, expMode,
+                                                           readOnly, encrypted);
                 rHandler.retJSObject(call, res, null);
             } catch (Exception e) {
                 String msg = "ExportToJson: " + e.getMessage();