@capgo/capacitor-data-storage-sqlite 6.0.0

package/readme.md

@@ -0,0 +1,203 @@
+<p align="center"><br><img src="https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png" width="128" height="128" /></p>
+<h3 align="center">DATA STORAGE SQLITE</h3>
+<p align="center"><strong><code>capacitor-data-storage-sqlite</code></strong></p>
+<br>
+<p align="center" style="font-size:50px;color:red"><strong>CAPACITOR 6</strong></p><br>
+<br>
+<!-- Note from the Owner - Start -->
+<p align="center" style="font-size:50px;color:red"><strong>Note from the Owner</strong></p>
+<!-- Note from the Owner - End -->
+<br>
+<!-- Message below Note from the Owner - Start -->
+<p align="left" style="font-size:47px">This Plugin has been transfered to Capgo org after his original creator <a href="https://github.com/jepiqueau">@jepiqueau</a> decide to retire. 
+<br>We will foreer be thankful for the work he did.</p>
+<br>
+<p align="center">
+  Capacitor Data Storage SQlite Plugin is a custom Native Capacitor plugin providing a key-value permanent store for simple data of <strong>type string only</strong> to SQLite on IOS, Android and Electron platforms and to IndexDB for the Web platform.</p>
+
+<p align="center">
+  <img src="https://img.shields.io/maintenance/yes/2023?style=flat-square" />
+  <a href="https://github.com/jepiqueau/capacitor-data-storage-sqlite/actions?query=workflow%3A%22CI%22"><img src="https://img.shields.io/github/workflow/status/jepiqueau/capacitor-data-storage-sqlite/CI?style=flat-square" /></a>
+  <a href="https://www.npmjs.com/package/jepiqueau/capacitor-data-storage-sqlite"><img src="https://img.shields.io/npm/l/capacitor-data-storage-sqlite.svg?style=flat-square" /></a>
+<br>
+  <a href="https://www.npmjs.com/package/jepiqueau/capacitor-data-storage-sqlite"><img src="https://img.shields.io/npm/dw/capacitor-data-storage-sqlite?style=flat-square" /></a>
+  <a href="https://www.npmjs.com/package/jepiqueau/capacitor-data-storage-sqlite"><img src="https://img.shields.io/npm/v/capacitor-data-storage-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-4-orange?style=flat-square" /></a>
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+</p>
+
+## Maintainers
+
+| Maintainer        | GitHub                                    | Social |
+| ----------------- | ----------------------------------------- | ------ |
+| Martin Donadieu   | [riderx](https://github.com/riderx)       |        |
+| Quéau Jean Pierre | [jepiqueau](https://github.com/jepiqueau) |        |
+
+## Browser Support
+
+The plugin follows the guidelines from the `Capacitor Team`,
+
+- [Capacitor Browser Support](https://capacitorjs.com/docs/v3/web#browser-support)
+
+meaning that it will not work in IE11 without additional JavaScript transformations, e.g. with [Babel](https://babeljs.io/).
+
+## Installation
+
+```bash
+npm install --save capacitor-data-storage-sqlite
+npx cap sync
+```
+
+- On iOS, no further steps are needed.
+
+- On Android, no further steps are needed.
+
+- On Web, 
+```bash
+npm install --save localforage
+```
+
+- On Electron
+```bash
+npm install --save @capacitor-community/electron
+npx cap add @capacitor-community/electron
+```
+Go to the Electron folder of your application
+
+```bash
+cd electron
+npm install --save sqlite3
+npm install --save-dev @types/sqlite3
+npm run build
+cd ..
+npx cap sync @capacitor-community/electron
+```
+
+Then build YOUR_APPLICATION
+
+```
+npm run build
+npx cap copy
+npx cap copy @capacitor-community/electron
+npx cap open ios
+npx cap open android
+npx cap open @capacitor-community/electron
+ionic serve
+```
+
+## Configuration
+
+No configuration required for this plugin
+
+## Supported methods
+
+| Name                         | Android | iOS | Electron | Web |
+| :--------------------------- | :------ | :-- | :------- | :-- |
+| openStore (non-encrypted DB) | ✅      | ✅  | ✅       | ✅  |
+| openStore (encrypted DB)     | ✅      | ✅  | ❌       | ❌  |
+| closeStore                   | ✅      | ✅  | ✅       | ❌  |
+| isStoreOpen                  | ✅      | ✅  | ✅       | ❌  |
+| isStoreExists                | ✅      | ✅  | ✅       | ❌  |
+| deleteStore                  | ✅      | ✅  | ✅       | ❌  |
+| setTable                     | ✅      | ✅  | ✅       | ✅  |
+| set                          | ✅      | ✅  | ✅       | ✅  |
+| get                          | ✅      | ✅  | ✅       | ✅  |
+| iskey                        | ✅      | ✅  | ✅       | ✅  |
+| keys                         | ✅      | ✅  | ✅       | ✅  |
+| values                       | ✅      | ✅  | ✅       | ✅  |
+| filtervalues                 | ✅      | ✅  | ✅       | ✅  |
+| keysvalues                   | ✅      | ✅  | ✅       | ✅  |
+| remove                       | ✅      | ✅  | ✅       | ✅  |
+| clear                        | ✅      | ✅  | ✅       | ✅  |
+| isTable                      | ✅      | ✅  | ✅       | ✅  |
+| tables                       | ✅      | ✅  | ✅       | ✅  |
+| deleteTable                  | ✅      | ✅  | ✅       | ❌  |
+| isJsonValid                  | ✅      | ✅  | ✅       | ✅  |
+| importFromJson               | ✅      | ✅  | ✅       | ✅  |
+| exportToJson                 | ✅      | ✅  | ✅       | ✅  |
+
+## Documentation
+
+- [API_Documentation](docs/API.md)
+
+- [USAGE_Documentation](docs/USAGE.md)
+
+## Applications demonstrating the use of the plugin
+
+### Ionic/Angular
+
+- [angular-data-storage-sqlite-app-starter](https://github.com/jepiqueau/angular-data-storage-sqlite-app-starter)
+
+### Ionic/React
+
+- [react-data-storage-sqlite-app-starter](https://github.com/jepiqueau/react-data-storage-sqlite-app-starter)
+
+### React
+
+- [react-datastoragesqlite-app](https://github.com/jepiqueau/react-datastoragesqlite-app)
+
+### Ionic/Vue
+
+- [vue-data-storage-sqlite-app-starter](https://github.com/jepiqueau/vue-data-storage-sqlite-app-starter)
+
+### Vue
+
+- [vue-datastoragesqlite-app](https://github.com/jepiqueau/vue-datastoragesqlite-app)
+
+## Usage
+
+- [see capacitor documentation](https://capacitor.ionicframework.com/docs/getting-started/with-ionic)
+
+- [see USAGE_Documentation](https://github.com/Cap-go/capacitor-data-storage-sqlite/blob/main/docs/USAGE.md)
+
+## Dependencies
+
+The IOS & Android code use SQLCipher allowing for database encryption. 
+The Android code is now based on `androidx.sqlite`. The database is not closed anymore after each transaction for performance improvement.
+You must manage the `close` of the database before opening a new database.
+The Web code use `localforage` package to store the datastore in the Browser.
+The Electron code use `sqlite3`package
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center"><a href="https://github.com/jepiqueau"><img src="https://avatars3.githubusercontent.com/u/16580653?v=4" width="100px;" alt=""/><br /><sub><b>Jean Pierre Quéau</b></sub></a><br /><a href="https://github.com/capacitor-data-storage-sqlite/commits?author=jepiqueau" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/mwpb"><img src="https://avatars.githubusercontent.com/u/12957941?v=4" width="100px;" alt=""/><br /><sub><b>Matthew Burke</b></sub></a><br /><a href="https://github.com/capacitor-data-storage-sqlite/commits?author=jepiqueau" title="Documentation">📖</a></td>    
+    <td align="center"><a href="https://github.com/mwpb"><img src="https://avatars.githubusercontent.com/u/1745820?v=4" width="100px;" alt=""/><br /><sub><b>Kevin van Schaijk</b></sub></a><br /><a href="https://github.com/capacitor-data-storage-sqlite/commits?author=jepiqueau" title="Code">💻</a></td>  
+    <td align="center"><a href="https://github.com/garbit"><img src="https://avatars.githubusercontent.com/u/555396?v=4" width="100px;" alt=""/><br /><sub><b>Andy Garbett</b></sub></a><br /><a href="https://github.com/capacitor-data-storage-sqlite/commits?author=jepiqueau" title="Documentation">📖</a></td>    
+     
+  </tr>
+</table>
+
+<!-- markdownlint-enable -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
+<p align="left" style="font-size:47px">Retirement message of @jepiqueau --></p>
+<br>
+<p align="left">
+I have been dedicated to developing and maintaining this plugin for many years since the inception of Ionic Capacitor. Now, at 73+ years old, and with my MacBook Pro becoming obsolete for running Capacitor 6 for iOS, I have made the decision to cease maintenance of the plugin. If anyone wishes to take ownership of this plugin, they are welcome to do so.  
+</p>
+<br>
+<p align="left">
+It has been a great honor to be part of this development journey alongside the developer community. I am grateful to see many of you following me on this path and incorporating the plugin into your applications. Your comments and suggestions have motivated me to continuously improve it.  
+</p>
+<br>
+<p align="left">
+I have made this decision due to several family-related troubles that require my full attention and time. Therefore, I will not be stepping back. Thank you to all of you for your support.
+</p>
+<br>
+<p align="left" style="font-size:47px">End <--</p>
+<!-- Message below Note from the Owner - End -->
+<br>
+