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

package/CHANGELOG.md

@@ -1,5 +1,22 @@
+## 3.3.3-2 (2022-01-03)
+
+### Added Features
+
+ - iOS Support for databases that are not visible to iTunes and are not backed up by iCloud issue#207
+
+### Bug Fixes
+
+ - fix README.md
+ - fix API.md
+
 ## 3.3.3-1 (2021-12-18)
 
+### Chore
+
+ - Update to @capacitor/core 3.3.3
+ - Update to @capacitor/ios 3.3.3
+ - Update to @capacitor/android 3.3.3
+
 ### Added Features
 
  - Open in Read-Only Mode databases without SQLite suffix 

package/README.md

@@ -16,7 +16,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-9-orange?style=flat-square" /></a>
+<a href="#contributors-"><img src="https://img.shields.io/badge/all%20contributors-10-orange?style=flat-square" /></a>
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 </p>
 
@@ -28,6 +28,23 @@
 
 ## CAPACITOR 3 (Master)
 
+🚨 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
@@ -308,7 +325,8 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <td align="center"><a href="https://github.com/digaus"><img src="https://avatars.githubusercontent.com/u/15358538?v=4" width="100px;" alt=""/><br /><sub><b>Dirk Gausmann</b></sub></a><br /><a href="https://github.com/capacitor-community/sqlite/commits?author=jepiqueau" title="Code">💻</a></td>
     <td align="center"><a href="https://github.com/IT-MikeS"><img src="https://avatars.githubusercontent.com/u/20338451?v=4" width="100px;" alt=""/><br /><sub><b>Mike Summerfeldt</b></sub></a><br /><a href="https://github.com/capacitor-community/sqlite/commits?author=jepiqueau" title="Code">💻</a></td>
     <td align="center"><a href="https://github.com/peakcool"><img src="https://avatars.githubusercontent.com/u/14804014?v=4" width="100px;" alt=""/><br /><sub><b>Peakcool</b></sub></a><br /><a href="https://github.com/capacitor-community/sqlite/commits?author=jepiqueau" title="Code">💻</a></td>
-    <td align="center"><a href="https://github.com/gion-andri"><img src="https://avatars.githubusercontent.com/u/540998?v=4" width="100px;" alt=""/><br /><sub><b>Gion-Andri Cantieni</b></sub></a><br /><a href="https://github.com/capacitor-community/sqlite/commits?author=jepiqueau" title="Documentation">💻</a></td>
+    <td align="center"><a href="https://github.com/gion-andri"><img src="https://avatars.githubusercontent.com/u/540998?v=4" width="100px;" alt=""/><br /><sub><b>Gion-Andri Cantieni</b></sub></a><br /><a href="https://github.com/capacitor-community/sqlite/commits?author=jepiqueau" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/robingenz"><img src="https://avatars.githubusercontent.com/u/13857929?v=4" width="100px;" alt=""/><br /><sub><b>Robin Genz</b></sub></a><br /><a href="https://github.com/capacitor-community/sqlite/commits?author=jepiqueau" title="Documentation">📖</a></td>
   </tr>
 </table>
 

package/ios/Plugin/CapacitorSQLite.swift

@@ -5,7 +5,19 @@ enum CapacitorSQLiteError: Error {
 // swiftlint:disable file_length
 // swiftlint:disable type_body_length
 @objc public class CapacitorSQLite: NSObject {
+    private var config: SqliteConfig
     private var dbDict: [String: Database] = [:]
+    private var databaseLocation: String
+
+    init(config: SqliteConfig) {
+        self.config = config
+        if let isLocation = config.iosDatabaseLocation {
+            self.databaseLocation = isLocation
+        } else {
+            self.databaseLocation = "Documents"
+        }
+        super.init()
+    }
 
     // MARK: - Echo
 
@@ -31,7 +43,9 @@ enum CapacitorSQLiteError: Error {
             // close all connections
             try closeAllConnections()
             // set encryption secret
-            try UtilsSecret.setEncryptionSecret(passphrase: passphrase)
+            try UtilsSecret
+                .setEncryptionSecret(passphrase: passphrase,
+                                     databaseLocation: databaseLocation)
             return
         } catch UtilsSecretError.setEncryptionSecret(let message) {
             throw CapacitorSQLiteError.failed(message: message)
@@ -48,7 +62,10 @@ enum CapacitorSQLiteError: Error {
             // close all connections
             try closeAllConnections()
             // set encryption secret
-            try UtilsSecret.changeEncryptionSecret(passphrase: passphrase, oldPassphrase: oldPassphrase)
+            try UtilsSecret
+                .changeEncryptionSecret(passphrase: passphrase,
+                                        oldPassphrase: oldPassphrase,
+                                        databaseLocation: databaseLocation)
             return
         } catch UtilsSecretError.changeEncryptionSecret(let message) {
             throw CapacitorSQLiteError.failed(message: message)
@@ -91,6 +108,7 @@ enum CapacitorSQLiteError: Error {
                 throw CapacitorSQLiteError.failed(message: "database \(databasePath) does not exist")
             }
             let mDb: Database = try Database(
+                databaseLocation: databaseLocation,
                 databaseName: databasePath,
                 encrypted: false, mode: "no-encryption", version: version,
                 vUpgDict: [:])
@@ -136,6 +154,7 @@ enum CapacitorSQLiteError: Error {
 
         do {
             let mDb: Database = try Database(
+                databaseLocation: databaseLocation,
                 databaseName: "\(mDbName)SQLite.db",
                 encrypted: encrypted, mode: mode, version: version,
                 vUpgDict: vUpgDict)
@@ -261,7 +280,8 @@ enum CapacitorSQLiteError: Error {
     @objc public func isDatabase(_ dbName: String) throws -> NSNumber {
         let mDbName = CapacitorSQLite.getDatabaseName(dbName: dbName)
         let isFileExists: Bool = UtilsFile
-            .isFileExist(fileName: mDbName + "SQLite.db")
+            .isFileExist(databaseLocation: databaseLocation,
+                         fileName: mDbName + "SQLite.db")
         if isFileExists {
             return 1
         } else {
@@ -459,7 +479,8 @@ enum CapacitorSQLiteError: Error {
             throw CapacitorSQLiteError.failed(message: msg)
         }
         let res: Bool = UtilsFile
-            .isFileExist(fileName: "\(mDbName)SQLite.db")
+            .isFileExist(databaseLocation: databaseLocation,
+                         fileName: "\(mDbName)SQLite.db")
         if res {
             return 1
         } else {
@@ -496,8 +517,7 @@ enum CapacitorSQLiteError: Error {
             if !mDb.isDBOpen() {
                 try mDb.open()
             }
-            let res: Bool = try mDb.deleteDB(
-                databaseName: "\(mDbName)SQLite.db")
+            let res: Bool = try mDb.deleteDB(databaseName: "\(mDbName)SQLite.db")
             if res {
                 return
             } else {
@@ -558,6 +578,7 @@ enum CapacitorSQLiteError: Error {
             // open the database
             do {
                 mDb = try Database(
+                    databaseLocation: databaseLocation,
                     databaseName: dbName, encrypted: encrypted,
                     mode: inMode, version: version, vUpgDict: [:])
                 try mDb.open()
@@ -760,7 +781,7 @@ enum CapacitorSQLiteError: Error {
             let aPath: String = assetsDbPath.path
             let bRes: Bool = UtilsFile.isDirExist(dirPath: aPath)
             if bRes {
-                // get the database files
+                // get the database files from assets
                 let dbList: [String] = try UtilsFile
                     .getFileList(path: aPath, ext: ".db")
                 // loop through the database files
@@ -772,7 +793,8 @@ enum CapacitorSQLiteError: Error {
                     // for each copy the file to the Application
                     // database folder
                     _ = try UtilsFile
-                        .copyFromAssetToDatabase(fromDb: mDb,
+                        .copyFromAssetToDatabase(databaseLocation: databaseLocation,
+                                                 fromDb: mDb,
                                                  toDb: toDb, overwrite: overwrite)
                 }
                 // get the zip files
@@ -783,7 +805,8 @@ enum CapacitorSQLiteError: Error {
                     // for each zip uncompress the file to the Application
                     // database folder
                     _ = try UtilsFile
-                        .unzipFromAssetToDatabase(zip: zip, overwrite: overwrite)
+                        .unzipFromAssetToDatabase(databaseLocation: databaseLocation,
+                                                  zip: zip, overwrite: overwrite)
                 }
                 return
             } else {
@@ -840,7 +863,9 @@ enum CapacitorSQLiteError: Error {
     @objc func addSQLiteSuffix(_ folderPath: String, dbList: [String]) throws {
 
         do {
-            try UtilsMigrate.addSQLiteSuffix(folderPath: folderPath, dbList: dbList)
+            try UtilsMigrate.addSQLiteSuffix(databaseLocation: databaseLocation,
+                                             folderPath: folderPath,
+                                             dbList: dbList)
             return
         } catch UtilsMigrateError.addSQLiteSuffix(let message) {
             var msg: String = "addSQLiteSuffix:"
@@ -858,7 +883,8 @@ enum CapacitorSQLiteError: Error {
 
     @objc func deleteOldDatabases(_ folderPath: String, dbList: [String]) throws {
         do {
-            try UtilsMigrate.deleteOldDatabases(folderPath: folderPath, dbList: dbList)
+            try UtilsMigrate
+                .deleteOldDatabases(folderPath: folderPath, dbList: dbList)
             return
         } catch UtilsMigrateError.deleteOldDatabases(let message) {
             var msg: String = "deleteOldDatabases:"