@capacitor-community/sqlite 3.2.5-1 → 3.3.2

package/CHANGELOG.md

@@ -1,3 +1,48 @@
+## 3.3.2 (2021-12-13)
+
+### Chore
+
+ - Update to @capacitor/core 3.3.2
+ - Update to @capacitor/ios 3.3.2
+ - Update to @capacitor/android 3.3.2
+
+### Bug Fixes
+
+ - fix addSQLiteSuffix skips databases without .db extension issue#200
+
+## 3.3.1 (2021-11-25)
+
+### Chore
+
+ - Update to @capacitor/core 3.3.1
+ - Update to @capacitor/ios 3.3.1
+ - Update to @capacitor/android 3.3.1
+
+### Added Features
+
+- add link to React-Vite and Vue-Vite application
+
+### Bug Fixes
+
+- fix Plugin failed to register in Android 11 physical device issue#196
+- fix Ionic-React-Usage.md
+- fix Ionic-Vue-Usage.md
+- fix Electron `npm install --save jszip`in README issue#197
+
+## 3.2.5 (2021-11-07)
+
+- stable release
+
+## 3.2.5-2 (2021-11-03)
+
+### Added Features 
+
+ - add importing zipped files using copyFromAssets method
+
+### Bug Fixes
+
+ - fix issue#191
+
 ## 3.2.5-1 (2021-10-22)
 
 ### Chore

package/CapacitorCommunitySqlite.podspec

@@ -14,5 +14,6 @@ Pod::Spec.new do |s|
   s.ios.deployment_target  = '12.0'
   s.dependency 'Capacitor'
   s.dependency 'SQLCipher'
+  s.dependency 'ZIPFoundation'
   s.swift_version = '5.1'
 end

package/README.md

@@ -28,6 +28,13 @@
 
 ## CAPACITOR 3 (Master)
 
+🚨 Since release 3.2.5-2 ->> 🚨
+
+  - support zip file in copyFromAssets method
+  - add optional `overwrite` parameter (true/false) default to true
+
+🚨 Since release 3.2.5-2 <<- 🚨
+
 🚨 Since release 3.2.3-1 ->> 🚨
 
 The `initWebStore` and `saveToStore` methods have been added to the Web platform.
@@ -46,72 +53,7 @@ The `initWebStore` and `saveToStore` methods have been added to the Web platform
   ```
  - the `saveToStore` allows to perform intermediate save of the database in case the browser needs to delete the cache.
  
-🚨 Since release 3.2.2-2 ->> 🚨
-
-The executeSet method accepts now no values, see below
-
-```
-const setIssue170: Array<capSQLiteSet>  = [
-  { statement: "DROP TABLE IF EXISTS issue170", values: [] },
-  { statement: "CREATE TABLE issue170 (src VARCHAR(255))", values: [] },
-  { statement: "INSERT INTO issue170 (src) values (?)", values: ["google.com"] },
-]
-```
-
-🚨 Since release 3.2.0-5 ->> 🚨
-
-The Web plugin is now implemented based on the stencil companion `jeep-sqlite@0.0.7` which is using `sql.js@1.5.0` for database queries and `localeforage@1.9.0`for database persistency.
-
-🚨 Since release 3.2.0-3 ->> 🚨
-
-The Electron plugin is now based on `@capacitor-community/electron@4.0.3` thanks to the hard and heavy work from `Mike Summerfeldt IT-MikeS` 👏 🙏
-
-🚨 Since release 3.2.0-2 ->> 🚨
-🚨 !!! for Electron developper, the Electron plugin is back !!! 🚨
-
-Based on `sqlite3`, so without encryption
-The two listeners `sqliteImportProgressEvent` and `sqliteExportProgressEvent` are not available.
-
-🚨 Since release 3.1.2 ->> 🚨
-
-Thanks to Nirajhinge and Chris, an example of using the TypeORM driver in a Ionic/Vue app has been developed see `https://github.com/jepiqueau/vue-typeorm-app`. 
-
-🚨 Since release 3.0.0-rc.2 ->> 🚨
-
-Thanks to Chris, a driver to TypeORM is now available
-
-🚨 Since release 3.0.0-beta.13 ->> 🚨
-
-  - GlobalSQLite `secret` and  `newsecret` are deprecated
-
-  - The user can now set its own secure secret (passphrase)
-
-    - use `setEncryptionSecret` ONCE to migrate encrypted databases
-      from `secret` to `secure stored secret`
-    
-    - use `changeEncryptionSecret` to change your `secure stored secret`
-
-  - iOS used `KeyChain service` to store the `secret`
-
-  - Android used `Encrypted SharedPreferences` to store the `secret`,
-    the minimun sdk should be set to 23 (limitation from Google)
-
-🚨 Since release 3.0.0-beta.13 ->> 🚨
-
-🚨 Since release 3.0.0-beta.11 ->> 🚨
-
-  - Checking of types has been removed in all methods of the plugin
-    both iOS & Android. This has been achieved to allow the use of
-    others RDBMS types. 
-    The type checking is now under the responsability of the developers.
-
-  - NULL values are now returned as null
-
-  - values for the `query` method is now an Array of any.
-
-  - option to disable `transaction` for the `execute`, `executeSet`, `run`.
-
-🚨 Since release 3.0.0-beta.11 <<- 🚨
+🚨 Since release 3.2.3-1 <<- 🚨
 
 The test has been achieved on:
 
@@ -121,55 +63,6 @@ The test has been achieved on:
 
 - a [Ionic/Vue app](https://github.com/jepiqueau/vue-sqlite-app-starter)
 
-## REFACTOR (Move to branch 2.9.x)
-
-The `2.9.x` is now 🛑 NOT MAINTAINED ANYMORE 🛑.
-
-The refactor offers now (since `2.9.0-beta.1`) all the features that the previous was offering. It has been a quite heavy process, hoping that the developpers will take benefit from it.
-
-The main reasons for it:
-
-- multiple database connections
-- db connector allowing for easy commands `db.open(), db.close, ...`
-- improve the response time of the encrypted database by removing the internal open and close database for each sqlite query
-- moving to the latest `androidx.sqlite.db.xxx`
-- offering encryption for Electron platform by using `@journeyapps/sqlcipher` on MacOs, !!! NOT ON WINDOWS !!!
-- cleaning and aligning the code between platforms
-- allowing developers to develop `typeorm` or `spatialite` drivers.
-
-This was discussed lengthly in issue#1 and issue#52
-
-Refactor available for `Android`, `iOS` and `Electron` platforms.
-
-The test has been achieved on:
-
-- a [Ionic/Angular app](https://github.com/jepiqueau/angular-sqlite-app-starter/tree/refactor)
-
-- a [Ionic/React app](https://github.com/jepiqueau/react-sqlite-app-starter/tree/refactor)
-
-- a [Ionic/Vue app](https://github.com/jepiqueau/vue-sqlite-app-starter/tree/refactor)
-
-Other frameworks will be tested later
-
-- Stencil
-
-## @INITIAL 🛑 (Move to branch 2.4.x)
-
-The `2.4.x` is now 🛑 NOT MAINTAINED ANYMORE 🛑.
-
-To install it
-
-```bash
-npm i --save @capacitor-community/sqlite@initial
-```
-The test has been achieved on:
-
-- a [Ionic/Angular app](https://github.com/jepiqueau/angular-sqlite-app-starter/tree/2.4.x)
-
-- a [Ionic/React app](https://github.com/jepiqueau/react-sqlite-app-starter/tree/2.4.x)
-
-- a [Ionic/Vue app](https://github.com/jepiqueau/vue-sqlite-app-starter/tree/2.4.x)
-
 
 ## Browser Support
 
@@ -222,6 +115,7 @@ npx cap sync @capacitor-community/electron
 ```bash
 cd electron
 npm install --save sqlite3
+npm install --save jszip
 npm install --save-dev @types/sqlite3
 npm run build
 ```
@@ -266,6 +160,11 @@ npx cap open android
 ```
 npx cap open @capacitor-community/electron
 ```
+
+## Readme previous releases
+
+[previous releases](https://github.com/capacitor-community/sqlite/readme_previous_release.md)
+
 ## Issues
 
 [issues](https://github.com/capacitor-community/sqlite/issues)
@@ -357,6 +256,11 @@ No configuration required for this plugin
 
 - [react-sqlite-app-starter](https://github.com/jepiqueau/react-sqlite-app-starter)
 
+### React+Vite
+
+- [react-vite-sqlite-app](https://github.com/jepiqueau/react-vite-sqlite-app)
+
+
 ### Ionic/Vue
 
 - [vue-sqlite-app-starter](https://github.com/jepiqueau/vue-sqlite-app-starter)
@@ -365,6 +269,10 @@ No configuration required for this plugin
 
 - [vue-sqlite-app](https://github.com/jepiqueau/vue-sqlite-app)
 
+### Vue+Vite
+
+- [vue-vite-sqlite-app](https://github.com/jepiqueau/vuevite-app)
+
 ## Usage
 
 - [see capacitor documentation](https://capacitor.ionicframework.com/docs/getting-started/with-ionic)
@@ -372,9 +280,10 @@ No configuration required for this plugin
 
 ## Dependencies
 
-The IOS and Android codes are using `SQLCipher` allowing for database encryption.
+The iOS and Android codes are using `SQLCipher` allowing for database encryption.
+The iOS codes is using `ZIPFoundation` for unzipping assets files
 The Electron code is using `sqlite3`.
-The Web code is using the Stencil component `jeep-sqlite` based on `sql.js` and `localforage`. 
+The Web code is using the Stencil component `jeep-sqlite` based on `sql.js`, `localforage`. and `jszip`  
 
 ## Contributors ✨
 

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

@@ -5,6 +5,7 @@ import android.content.SharedPreferences;
 import android.text.TextUtils;
 import android.util.Log;
 import androidx.security.crypto.EncryptedSharedPreferences;
+import androidx.security.crypto.MasterKey;
 import androidx.security.crypto.MasterKeys;
 import com.getcapacitor.JSArray;
 import com.getcapacitor.JSObject;
@@ -46,14 +47,13 @@ public class CapacitorSQLite {
         try {
             // create or retrieve masterkey from Android keystore
             // it will be used to encrypt the passphrase for a database
-            String masterKeyAlias = MasterKeys.getOrCreate(MasterKeys.AES256_GCM_SPEC);
-
+            MasterKey masterKeyAlias = new MasterKey.Builder(context).setKeyScheme(MasterKey.KeyScheme.AES256_GCM).build();
             // get instance of the EncryptedSharedPreferences class
             this.sharedPreferences =
                 EncryptedSharedPreferences.create(
+                    context,
                     "sqlite_encrypted_shared_prefs",
                     masterKeyAlias,
-                    context,
                     EncryptedSharedPreferences.PrefKeyEncryptionScheme.AES256_SIV,
                     EncryptedSharedPreferences.PrefValueEncryptionScheme.AES256_GCM
                 );
@@ -724,10 +724,10 @@ public class CapacitorSQLite {
         }
     }
 
-    public void copyFromAssets() throws Exception {
+    public void copyFromAssets(Boolean overwrite) throws Exception {
         String msg = "copy failed : ";
         try {
-            uFile.copyFromAssetsToDatabase(context);
+            uFile.copyFromAssetsToDatabase(context, overwrite);
             return;
         } catch (Exception e) {
             msg += e.getMessage();

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

@@ -562,7 +562,6 @@ public class CapacitorSQLitePlugin extends Plugin {
             return;
         }
         JSArray values = call.getArray("values");
-        Log.v(TAG, "CapacitorSQLitePlugin: " + values);
 
         Boolean transaction = call.getBoolean("transaction", true);
 
@@ -897,8 +896,10 @@ public class CapacitorSQLitePlugin extends Plugin {
      */
     @PluginMethod
     public void copyFromAssets(PluginCall call) {
+        Boolean overwrite = call.getData().has("overwrite") ? call.getBoolean("overwrite") : true;
+
         try {
-            implementation.copyFromAssets();
+            implementation.copyFromAssets(overwrite);
             rHandler.retResult(call, null, null);
             return;
         } catch (Exception e) {

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

@@ -95,7 +95,6 @@ public class Database {
      * Initialize the SQLCipher Libraries
      */
     private void InitializeSQLCipher() {
-        Log.d(TAG, " in InitializeSQLCipher: ");
         SQLiteDatabase.loadLibs(_context);
     }
 
@@ -286,7 +285,6 @@ public class Database {
                 if (transaction) _db.beginTransaction();
                 for (String cmd : statements) {
                     if (!cmd.endsWith(";")) cmd += ";";
-                    Log.v(TAG, " cmd " + cmd);
                     _db.execSQL(cmd);
                 }
                 changes = _uSqlite.dbChanges(_db) - initChanges;
@@ -319,7 +317,6 @@ public class Database {
         try {
             if (_db != null && _db.isOpen()) {
                 Integer initChanges = _uSqlite.dbChanges(_db);
-                Log.v(TAG, "ExecuteSet InitChanges " + initChanges);
                 if (transaction) _db.beginTransaction();
                 for (int i = 0; i < set.length(); i++) {
                     JSONObject row = set.getJSONObject(i);
@@ -348,7 +345,6 @@ public class Database {
                 if (lastId != -1) {
                     if (transaction) _db.setTransactionSuccessful();
                     changes = _uSqlite.dbChanges(_db) - initChanges;
-                    Log.v(TAG, "Execute Changes " + changes);
                     retObj.put("changes", changes);
                     retObj.put("lastId", lastId);
                     return retObj;
@@ -388,12 +384,10 @@ public class Database {
         try {
             if (_db != null && _db.isOpen() && statement.length() > 0) {
                 Integer initChanges = _uSqlite.dbChanges(_db);
-                Log.v(TAG, "runSQL InitChanges " + initChanges);
                 if (transaction) _db.beginTransaction();
                 lastId = prepareSQL(statement, values);
                 if (lastId != -1 && transaction) _db.setTransactionSuccessful();
                 changes = _uSqlite.dbChanges(_db) - initChanges;
-                Log.v(TAG, "runSQL Changes " + changes);
                 retObj.put("changes", changes);
                 retObj.put("lastId", lastId);
                 return retObj;
@@ -601,7 +595,6 @@ public class Database {
      * @return
      */
     public JSObject importFromJson(JsonSQLite jsonSQL) throws Exception {
-        Log.d(TAG, "importFromJson:  ");
         JSObject retObj = new JSObject();
         int changes = Integer.valueOf(0);
         try {

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

@@ -12,6 +12,8 @@ import java.io.OutputStream;
 import java.nio.channels.FileChannel;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.zip.ZipEntry;
+import java.util.zip.ZipInputStream;
 
 public class UtilsFile {
 
@@ -53,7 +55,7 @@ public class UtilsFile {
         return file.delete();
     }
 
-    public void copyFromAssetsToDatabase(Context context) throws Exception {
+    public void copyFromAssetsToDatabase(Context context, Boolean overwrite) throws Exception {
         AssetManager assetManager = context.getAssets();
         String assetsDatabasePath = "public/assets/databases";
         try {
@@ -73,22 +75,80 @@ public class UtilsFile {
                 for (int i = 0; i < filelist.length; i++) {
                     // Get filename of file or directory
                     String fileName = filelist[i];
-                    boolean isDB = isLast(fileName, ".db");
-                    if (!isDB) continue;
-                    String toFileName = fileName;
-                    boolean isSQLite = isLast(fileName, "SQLite.db");
-                    if (!isSQLite) {
-                        toFileName = fileName.substring(0, fileName.length() - 3) + "SQLite.db";
+                    if (isLast(fileName, ".db")) {
+                        String toFileName = addSQLiteSuffix(fileName);
+                        boolean isExist = isFileExists(context, toFileName);
+                        if (!isExist || overwrite) {
+                            if (overwrite && isExist) {
+                                deleteDatabase(context, toFileName);
+                            }
+                            String fromPathName = assetsDatabasePath + "/" + fileName;
+                            String toPathName = context.getDatabasePath(toFileName).getAbsolutePath();
+                            copyDatabaseFromAssets(assetManager, fromPathName, toPathName);
+                        }
+                    }
+                    if (isLast(fileName, ".zip")) {
+                        // unzip file and extract databases
+                        String zipPathName = assetsDatabasePath + "/" + fileName;
+                        unzipCopyDatabase(context, assetManager, zipPathName, assetsDatabasePath, overwrite);
                     }
-                    String fromPathName = assetsDatabasePath + "/" + fileName;
-                    String toPathName = context.getDatabasePath(toFileName).getAbsolutePath();
-                    copyDatabaseFromAssets(assetManager, fromPathName, toPathName);
                 }
                 return;
             }
         } catch (IOException e) {
-            throw new Exception("in isDirExists " + e.getLocalizedMessage());
+            throw new Exception("in copyFromAssetsToDatabase " + e.getLocalizedMessage());
+        }
+    }
+
+    public void unzipCopyDatabase(Context context, AssetManager asm, String zipPath, String assetsDatabasePath, Boolean overwrite)
+        throws IOException {
+        InputStream is;
+        byte[] buffer = new byte[1024];
+        try {
+            is = asm.open(zipPath);
+            ZipInputStream zis = new ZipInputStream(is);
+
+            ZipEntry ze = zis.getNextEntry();
+            while (ze != null) {
+                String fileName = ze.getName();
+                if (isLast(fileName, ".db")) {
+                    String toFileName = addSQLiteSuffix(fileName);
+                    boolean isExist = isFileExists(context, toFileName);
+                    if (!isExist || overwrite) {
+                        if (overwrite && isExist) {
+                            deleteDatabase(context, toFileName);
+                        }
+                        String toPathName = context.getDatabasePath(toFileName).getAbsolutePath();
+                        File newFile = new File(toPathName);
+                        System.out.println("Unzipping to " + newFile.getAbsolutePath());
+                        FileOutputStream fos = new FileOutputStream(newFile);
+                        int len;
+                        while ((len = zis.read(buffer)) > 0) {
+                            fos.write(buffer, 0, len);
+                        }
+                        fos.close();
+                    }
+                    //close this ZipEntry
+                    zis.closeEntry();
+                    ze = zis.getNextEntry();
+                }
+            }
+            //close last ZipEntry
+            zis.closeEntry();
+            zis.close();
+            is.close();
+        } catch (IOException e) {
+            throw new IOException("in unzipCopyDatabase " + e.getLocalizedMessage());
+        }
+    }
+
+    public String addSQLiteSuffix(String fileName) {
+        String toFileName = fileName;
+        boolean isSQLite = isLast(fileName, "SQLite.db");
+        if (!isSQLite) {
+            toFileName = fileName.substring(0, fileName.length() - 3) + "SQLite.db";
         }
+        return toFileName;
     }
 
     public void copyDatabaseFromAssets(AssetManager asm, String inPath, String outPath) throws IOException {

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

@@ -43,17 +43,28 @@ public class UtilsMigrate {
             throw new Exception("Folder " + dir + " no database files");
         }
         for (String file : listFiles) {
-            if (uFile.getFileExtension((file)).equals("db")) {
-                if (!file.contains("SQLite.db")) {
+            if (!file.contains("SQLite.db")) {
+                String fromFile = file;
+                String toFile = "";
+                if (dbList.size() > 0) {
                     if (dbList.contains(file)) {
-                        String fromFile = file;
-                        String toFile = file.replace(".db", "SQLite.db");
-                        boolean ret = uFile.copyFromNames(context, pathFiles, fromFile, pathDB, toFile);
-                        if (!ret) {
-                            String msg = "Failed in copy " + fromFile + " to " + file;
-                            throw new Exception(msg);
+                        if (uFile.getFileExtension((file)).equals("db")) {
+                            toFile = file.replace(".db", "SQLite.db");
+                        } else {
+                            toFile = file.concat("SQLite.db");
                         }
                     }
+                } else {
+                    if (uFile.getFileExtension((file)).equals("db")) {
+                        toFile = file.replace(".db", "SQLite.db");
+                    }
+                }
+                if (toFile.length() > 0) {
+                    boolean ret = uFile.copyFromNames(context, pathFiles, fromFile, pathDB, toFile);
+                    if (!ret) {
+                        String msg = "Failed in copy " + fromFile + " to " + file;
+                        throw new Exception(msg);
+                    }
                 }
             }
         }
@@ -89,14 +100,22 @@ public class UtilsMigrate {
         }
         String[] listFiles = dir.list();
         for (String file : listFiles) {
-            if (uFile.getFileExtension((file)).equals("db")) {
-                if (!file.contains("SQLite.db")) {
+            String delFile = "";
+            if (!file.contains("SQLite.db")) {
+                if (dbList.size() > 0) {
                     if (dbList.contains(file)) {
-                        boolean ret = uFile.deleteFile(pathFiles, file);
-                        if (!ret) {
-                            String msg = "Failed in delete " + file;
-                            throw new Exception(msg);
-                        }
+                        delFile = file;
+                    }
+                } else {
+                    if (uFile.getFileExtension((file)).equals("db")) {
+                        delFile = file;
+                    }
+                }
+                if (delFile.length() > 0) {
+                    boolean ret = uFile.deleteFile(pathFiles, delFile);
+                    if (!ret) {
+                        String msg = "Failed in delete " + delFile;
+                        throw new Exception(msg);
                     }
                 }
             }

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

@@ -333,7 +333,6 @@ public class UtilsUpgrade {
                 String stmt = "UPDATE sync_table SET ";
                 stmt += "sync_date = " + syncTime;
                 stmt += " WHERE id = 1;";
-                Log.v(TAG, "*** New SyncDate " + syncTime);
                 try {
                     db.runSQL(stmt, new ArrayList<>());
                 } catch (Exception e) {

package/dist/esm/definitions.d.ts

@@ -201,11 +201,11 @@ export interface CapacitorSQLitePlugin {
     addUpgradeStatement(options: capSQLiteUpgradeOptions): Promise<void>;
     /**
      * Copy databases from public/assets/databases folder to application databases folder
-     *
+     * @param options: capSQLiteFromAssets  since 3.2.5-2
      * @returns Promise<void>
      * @since 2.9.0 refactor
      */
-    copyFromAssets(): Promise<void>;
+    copyFromAssets(options: capSQLiteFromAssetsOptions): Promise<void>;
     /**
      * Get the database list
      * @returns Promise<capSQLiteValues>
@@ -384,6 +384,14 @@ export interface capSQLiteExportOptions {
      */
     jsonexportmode?: string;
 }
+export interface capSQLiteFromAssetsOptions {
+    /**
+     * Set the overwrite mode for the copy from assets
+     * "true"/"false"  default to "true"
+     *
+     */
+    overwrite?: boolean;
+}
 export interface capSQLiteSyncDateOptions {
     /**
      * The database name
@@ -740,10 +748,11 @@ export interface ISQLiteConnection {
     isJsonValid(jsonstring: string): Promise<capSQLiteResult>;
     /**
      * Copy databases from public/assets/databases folder to application databases folder
+     * @param overwrite  since 3.2.5-2
      * @returns Promise<void>
      * @since 2.9.0 refactor
      */
-    copyFromAssets(): Promise<void>;
+    copyFromAssets(overwrite?: boolean): Promise<void>;
     /**
      * Check if a database exists
      * @param database
@@ -804,7 +813,7 @@ export declare class SQLiteConnection implements ISQLiteConnection {
     checkConnectionsConsistency(): Promise<capSQLiteResult>;
     importFromJson(jsonstring: string): Promise<capSQLiteChanges>;
     isJsonValid(jsonstring: string): Promise<capSQLiteResult>;
-    copyFromAssets(): Promise<void>;
+    copyFromAssets(overwrite?: boolean): Promise<void>;
     isDatabase(database: string): Promise<capSQLiteResult>;
     getDatabaseList(): Promise<capSQLiteValues>;
     getMigratableDbList(folderPath: string): Promise<capSQLiteValues>;

package/dist/esm/definitions.js

@@ -186,9 +186,10 @@ export class SQLiteConnection {
             return Promise.reject(err);
         }
     }
-    async copyFromAssets() {
+    async copyFromAssets(overwrite) {
+        const mOverwrite = overwrite != null ? overwrite : true;
         try {
-            await this.sqlite.copyFromAssets();
+            await this.sqlite.copyFromAssets({ overwrite: mOverwrite });
             return Promise.resolve();
         }
         catch (err) {