@capacitor-community/sqlite 4.1.0-1 → 4.1.0-2

package/README.md

@@ -28,187 +28,11 @@
 
 ## CAPACITOR 4 (Master)
 
-🚨 Release 4.0.1 all platforms ->> 🚨
+For more info on releases:
 
-  As no any issues where opened against version 4.0.0-1 using Capacitor 4,
-  Developers can now install it as normal
+ - [info_releases](https://github.com/capacitor-community/sqlite/blob/master/info_releases.md)
 
-  ```
-  npm install @capacitor-community/sqlite@latest
-  ```  
-
-🚨 Release 4.0.1 <<- 🚨
-
-🚨 Release 4.0.0-1 all platforms ->> 🚨
-  This is a tentative of implementing @Capacitor/core@4.0.1 proposed by rdlabo (Masahiko Sakakibara). 
-  For those who want to try it do
-  ```
-  npm install @capacitor-community/sqlite@next
-  ```
-  Revert quickly any issue by clearly mentionning V4 in the title of the issue.
-
-  Thanks for your help in testing
-
-🚨 Release 4.0.0-1 <<- 🚨
-
-## CAPACITOR 3 (v3.7.0)
-
-🚨 Release 3.4.3-3 all platforms ->> 🚨
-
-The main change is related to the delete table's rows when a synchronization table exists as well as a last_mofidied table's column, allowing for database synchronization of the local database with a remote server database.
-
-- All existing triggers to YOUR_TABLE_NAME_trigger_last_modified must be modified as follows
-  ```
-  CREATE TRIGGER YOUR_TABLE_NAME_trigger_last_modified
-    AFTER UPDATE ON YOUR_TABLE_NAME
-    FOR EACH ROW WHEN NEW.last_modified < OLD.last_modified
-    BEGIN
-        UPDATE YOUR_TABLE_NAME SET last_modified= (strftime('%s', 'now')) WHERE id=OLD.id;
-    END;
-  ```
-- an new column `sql_deleted` must be added to each of your tables as
-  ```
-  sql_deleted BOOLEAN DEFAULT 0 CHECK (sql_deleted IN (0, 1))
-  ```
-  This column will be autommatically set to 1 when you will use a `DELETE FROM ...` sql statement in the `execute`, `run` or `executeSet` methods.
-
-- In the JSON object that you provide to `importFromJson`, all the deleted rows in your remote server database's tables must have the `sql_deleted` column set to 1. This will indicate to the import process to physically delete the corresponding rows in your local database. All the others rows must have the `sql_deleted` column set to 0. 
-
-- In the JSON object outputs by the `exportToJson`, all the deleted rows in your local database have got the `sql_deleted` column set to 1 to help in your synchronization management process with the remote server database. A system `last_exported_date` is automatically saved in the synchronization table at the start of the export process flow.
-
-- On successful completion of your synchronization management process with the remote server database, you must 
-  - Set a new synchronization date (as `(new Date()).toISOString()`) with the `setSyncDate` method.
-  - Execute the `deleteExportedRows` method which physically deletes all table's rows having 1 as value for the `sql_deleted` column prior to the `last_exported_date` in your local database.
-
-An example of using this new feature is given in [solidjs-vite-sqlite-app](https://github.com/jepiqueau/capacitor-solid-sqlite). It has been used to test the validity of the implementation.
-
-
-🚨 Release 3.4.3-3 <<- 🚨
-
-🚨 Release 3.4.2-4 ->> 🚨
-!!!! DO NOT USE IT !!!!
-🚨 Release 3.4.2-4 <<- 🚨
-
-🚨 Since release 3.4.2-3 ->> 🚨
-
- - **overwrite** boolean parameter has been added to the Json Object (default false) 
-   - `true` : delete the physically the database whatever the version is.
-   - `false`: 
-      - re-importing a database with the same `version` number will do nothing, keeping the existing database and will return `changes = 0`
-      - re-importing a database with a lower `version` number will throw an error `ImportFromJson: Cannot import a version lower than `
-
- - During an import in `full` mode the `Foreign Key` constraint has been turn off before dropping the tables and turn back on after
-
-🚨 Since release 3.4.2-3 <<- 🚨
-🚨 Since release 3.4.1 ->> 🚨
-  Databases location for Electron can be set in `the config.config.ts` as followed:
-
-  - for sharing databases between users:
-
-    ``` 
-    plugins: {
-      CapacitorSQLite: {
-        electronMacLocation: "/YOUR_DATABASES_PATH",
-        electronWindowsLocation: "C:\\ProgramData\\CapacitorDatabases",
-        electronLinuxLocation: "/home/CapacitorDatabases"
-      }
-    }
-    ``` 
-
-  - for only the user in its Home folder
-
-    ``` 
-    Plugins: {
-      CapacitorSQLite: {
-        electronMacLocation: "Databases",
-        electronWindowsLocation: "Databases",
-        electronLinuxLocation: "Databases"
-      }
-    }
-    ``` 
-
-  For existing databases, YOU MUST COPY old databases to the new location
-  You MUST remove the Electron folder and add it again with
-
-  ``` 
-  npx cap add @capacitor-community/electron
-  npm run build 
-  cd electron
-  npm i --save sqlite3
-  npm i --save @types:sqlite3
-  npm run rebuild
-  cd ..
-  npx cap sync @capacitor-community/electron
-  npm run build
-  npx cap copy @capacitor-community/electron
-  npx cap open @capacitor-community/electron
-  ``` 
-🚨 Since release 3.4.1 <<- 🚨
-
-🚨 Since release 3.4.1-1 ->> 🚨
-
-  - add iosIsEncryption, androidIsEncryption in capacitor.config.ts
-    When your application use only `non-encrypted databases` set those parameter to false then iOS KeyChain & Android MasterKey are not defined.
-    
-🚨 Since release 3.4.1-1 <<- 🚨
-
-🚨 Since release 3.4.0-2 ->> 🚨 
-
-- iOS & Android only
-  Adding biometric FaceID/TouchID to secure the pass phrase in the Keychain/SharedPreferences stores. see:
-   [Biometric_Authentication](https://github.com/capacitor-community/sqlite/blob/master/docs/Biometric-Authentication.md)
-
-- iOS only
-  Fix identical pass phrase stored in the Keychain for differents applications using the plugin by adding an application prefix to the Keychain account.
-  Before the account `"CapacitorSQLitePlugin"` was used and was the same for all applications.
-  Now by adding `iosKeychainPrefix: 'YOUR_APP_NAME'`in the `capacitor.config.ts` of your application,
-  the account will be `"YOUR_APP_NAME_CapacitorSQLitePlugin"`
-  If you were having a pass phrase stored, first modify the `capacitor.config.ts` and then run the command `isSecretStored` which will manage the upgrade of the Keychain account. 
-🚨 Since release 3.4.0-2 <<- 🚨
-
-🚨 Since release 3.3.3-2 ->> 🚨
-
-  - iOS only
-    Support for a database location not visible to iTunes and backed up to iCloud.
-    For this you must add to the `const config: CapacitorConfig` of the `capacitor.config.ts` file of your application the following:
-    ```ts
-      plugins: {
-        CapacitorSQLite: {
-          "iosDatabaseLocation": "Library/CapacitorDatabase"
-        }
-      }
-    ``` 
-    Pre-existing databases from the `Documents` folder will be moved to the new folder `Library/CapacitorDatabase` and your application will work as before.
-    If you do not modify the `capacitor.config.ts` file of your application the databases will still reside in the `Documents` folder
-
-🚨 Since release 3.3.3-2 <<- 🚨
-
-🚨 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.
- - The `initWebStore` has been added to fix the issue#172 and since then is `MANDATORY`
-  ```js
-  ...
-  if(platform === "web") {
-    await customElements.whenDefined('jeep-sqlite');
-    const jeepSqliteEl = document.querySelector('jeep-sqlite');
-    if(jeepSqliteEl != null) {
-      await sqliteConnection.initWebStore()
-      ...
-    }
-  }
-  ...
-  ```
- - the `saveToStore` allows to perform intermediate save of the database in case the browser needs to delete the cache.
- 
-🚨 Since release 3.2.3-1 <<- 🚨
+ - [changelog]https://github.com/capacitor-community/sqlite/blob/master/changelog.md
 
 The test has been achieved on:
 
@@ -224,6 +48,7 @@ The test has been achieved on:
 
 - a [Vue TypeORM app](https://github.com/jepiqueau/vue-typeorm-app)
 
+- a [SolidJS Vite app](https://github.com/jepiqueau/capacitor-solid-sqlite)
 
 ## Browser Support
 
@@ -315,6 +140,15 @@ npx cap open ios
 ```
 npx cap open android
 ```
+In case you get the following error:
+`x files found with path 'build-data.properties'.`
+You can you add the following code to `app/build.gradle`:
+```
+    packagingOptions {
+        exclude 'build-data.properties'
+    }
+```
+See [#301](https://github.com/capacitor-community/sqlite/issues/301) and [SO](https://stackoverflow.com/questions/63291529/how-to-fix-more-than-one-file-was-found-with-os-independent-path-build-data-pro] for more information.
 
 ### Electron
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capacitor-community/sqlite",
-  "version": "4.1.0-1",
+  "version": "4.1.0-2",
   "description": "Community plugin for native & electron SQLite databases",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",