@capacitor-community/sqlite 5.0.0-beta.2 → 5.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +53 -41
- package/android/build.gradle +0 -7
- package/android/src/main/AndroidManifest.xml +2 -2
- package/electron/dist/plugin.js +229 -129
- package/electron/dist/plugin.js.map +1 -1
- package/electron/rollup.config.js +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<p align="center"><br><img src="https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png" width="128" height="128" /></p>
|
|
2
2
|
<h3 align="center">SQLITE DATABASE</h3>
|
|
3
|
-
<p align="center"><strong><code>@capacitor-community/sqlite
|
|
3
|
+
<p align="center"><strong><code>@capacitor-community/sqlite</code></strong></p>
|
|
4
4
|
<br>
|
|
5
5
|
<p align="center" style="font-size:50px;color:red"><strong>CAPACITOR 5</strong></p><br>
|
|
6
6
|
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
<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>
|
|
17
17
|
<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>
|
|
18
18
|
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
|
19
|
-
<a href="#contributors-"><img src="https://img.shields.io/badge/all%20contributors-
|
|
19
|
+
<a href="#contributors-"><img src="https://img.shields.io/badge/all%20contributors-36-orange?style=flat-square" /></a>
|
|
20
20
|
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
|
21
21
|
</p>
|
|
22
22
|
|
|
@@ -30,17 +30,17 @@
|
|
|
30
30
|
To install:
|
|
31
31
|
|
|
32
32
|
```
|
|
33
|
-
npm install --save @capacitor-community/sqlite
|
|
33
|
+
npm install --save @capacitor-community/sqlite
|
|
34
34
|
npx cap sync
|
|
35
35
|
```
|
|
36
36
|
|
|
37
37
|
```
|
|
38
|
-
yarn add @capacitor-community/sqlite
|
|
38
|
+
yarn add @capacitor-community/sqlite
|
|
39
39
|
npx cap sync
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
```
|
|
43
|
-
pnpm install --save @capacitor-community/sqlite
|
|
43
|
+
pnpm install --save @capacitor-community/sqlite
|
|
44
44
|
pnpm install --save @jeep-sqlite
|
|
45
45
|
pnpm install --save sql.js
|
|
46
46
|
npx cap sync
|
|
@@ -48,37 +48,44 @@ npx cap sync
|
|
|
48
48
|
|
|
49
49
|
then add plugin to main `capacitor.config.json` file:
|
|
50
50
|
|
|
51
|
-
```
|
|
52
|
-
{
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
51
|
+
```ts
|
|
52
|
+
import { CapacitorConfig } from '@capacitor/cli';
|
|
53
|
+
|
|
54
|
+
const config: CapacitorConfig = {
|
|
55
|
+
appId: 'com.jeep.app.ionic7.angular.sqlite',
|
|
56
|
+
appName: 'ionic7-angular-sqlite-starter',
|
|
57
|
+
webDir: 'www',
|
|
58
|
+
server: {
|
|
59
|
+
androidScheme: 'https'
|
|
60
|
+
},
|
|
61
|
+
plugins: {
|
|
62
|
+
CapacitorSQLite: {
|
|
63
|
+
iosDatabaseLocation: 'Library/CapacitorDatabase',
|
|
64
|
+
iosIsEncryption: true,
|
|
65
|
+
iosKeychainPrefix: 'angular-sqlite-app-starter',
|
|
66
|
+
iosBiometric: {
|
|
67
|
+
biometricAuth: false,
|
|
68
|
+
biometricTitle : "Biometric login for capacitor sqlite"
|
|
65
69
|
},
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
70
|
+
androidIsEncryption: true,
|
|
71
|
+
androidBiometric: {
|
|
72
|
+
biometricAuth : false,
|
|
73
|
+
biometricTitle : "Biometric login for capacitor sqlite",
|
|
74
|
+
biometricSubTitle : "Log in using your biometric"
|
|
71
75
|
},
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
76
|
+
electronWindowsLocation: "C:\\ProgramData\\CapacitorDatabases",
|
|
77
|
+
electronMacLocation: "/Volumes/Development_Lacie/Development/Databases",
|
|
78
|
+
electronLinuxLocation: "Databases"
|
|
75
79
|
}
|
|
76
80
|
}
|
|
77
|
-
}
|
|
81
|
+
};
|
|
82
|
+
export default config;
|
|
83
|
+
|
|
78
84
|
```
|
|
79
85
|
|
|
80
86
|
## More Reading:
|
|
81
87
|
|
|
88
|
+
- [Updating to Capacitor 5](https://capacitorjs.com/docs/updating/5-0)
|
|
82
89
|
- [Releases](https://github.com/capacitor-community/sqlite/blob/master/info_releases.md)
|
|
83
90
|
- [Changelog](https://github.com/capacitor-community/sqlite/blob/master/CHANGELOG.md)
|
|
84
91
|
- [Issues](https://github.com/capacitor-community/sqlite/issues)
|
|
@@ -116,8 +123,8 @@ You'll need the usual capacitor/android/react npm script to build and copy the a
|
|
|
116
123
|
See [#301](https://github.com/capacitor-community/sqlite/issues/301) and [SO question](https://stackoverflow.com/questions/63291529/how-to-fix-more-than-one-file-was-found-with-os-independent-path-build-data-pro) for more information.
|
|
117
124
|
|
|
118
125
|
- Check/Add the following:
|
|
119
|
-
Gradle JDK version
|
|
120
|
-
Android Gradle Plugin Version
|
|
126
|
+
Gradle JDK version 17
|
|
127
|
+
Android Gradle Plugin Version 8.0.0
|
|
121
128
|
In variables.gradle
|
|
122
129
|
|
|
123
130
|
```
|
|
@@ -157,10 +164,9 @@ You'll need the usual capacitor/android/react npm script to build and copy the a
|
|
|
157
164
|
|
|
158
165
|
```bash
|
|
159
166
|
cd electron
|
|
160
|
-
npm install --save
|
|
167
|
+
npm install --save @journeyapps/sqlcipher
|
|
161
168
|
npm install --save jszip
|
|
162
169
|
npm install --save node-fetch@2.6.7
|
|
163
|
-
npm install --save-dev @types/sqlite3
|
|
164
170
|
```
|
|
165
171
|
- **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.
|
|
166
172
|
|
|
@@ -180,7 +186,7 @@ npm install --save-dev @types/sqlite3
|
|
|
180
186
|
| isConnection (ReadWrite) | ✅ | ✅ | ✅ | ✅ |
|
|
181
187
|
| isConnection (ReadOnly) | ✅ | ✅ | ✅ | ❌ | since 4.1.0-7
|
|
182
188
|
| open (non-encrypted DB) | ✅ | ✅ | ✅ | ✅ |
|
|
183
|
-
| open (encrypted DB) | ✅ | ✅ |
|
|
189
|
+
| open (encrypted DB) | ✅ | ✅ | ✅ | ❌ |
|
|
184
190
|
| close | ✅ | ✅ | ✅ | ✅ |
|
|
185
191
|
| getUrl | ✅ | ✅ | ❌ | ❌ |
|
|
186
192
|
| getVersion | ✅ | ✅ | ✅ | ✅ |
|
|
@@ -209,10 +215,10 @@ npm install --save-dev @types/sqlite3
|
|
|
209
215
|
| deleteOldDatabases | ✅ | ✅ | ❌ | ❌ |
|
|
210
216
|
| moveDatabasesAndAddSuffix | ✅ | ✅ | ❌ | ❌ |
|
|
211
217
|
| checkConnectionsConsistency | ✅ | ✅ | ✅ | ✅ |
|
|
212
|
-
| isSecretStored | ✅ | ✅ |
|
|
213
|
-
| setEncryptionSecret | ✅ | ✅ |
|
|
214
|
-
| changeEncryptionSecret | ✅ | ✅ |
|
|
215
|
-
| clearEncryptionSecret | ✅ | ✅ |
|
|
218
|
+
| isSecretStored | ✅ | ✅ | ✅ | ❌ |
|
|
219
|
+
| setEncryptionSecret | ✅ | ✅ | ✅ | ❌ |
|
|
220
|
+
| changeEncryptionSecret | ✅ | ✅ | ✅ | ❌ |
|
|
221
|
+
| clearEncryptionSecret | ✅ | ✅ | ✅ | ❌ |
|
|
216
222
|
| checkEncryptionSecret | ✅ | ✅ | ❌ | ❌ |
|
|
217
223
|
| initWebStore | ❌ | ❌ | ❌ | ✅ |
|
|
218
224
|
| saveToStore | ❌ | ❌ | ❌ | ✅ |
|
|
@@ -259,7 +265,7 @@ npm install --save-dev @types/sqlite3
|
|
|
259
265
|
|
|
260
266
|
- [Ionic/Angular Usage Documentation](https://github.com/capacitor-community/sqlite/blob/master/docs/Ionic-Angular-Usage.md)
|
|
261
267
|
|
|
262
|
-
- [
|
|
268
|
+
- [ionic7-angular-sqlite-starter](https://github.com/jepiqueau/ionic7-angular-sqlite-starter) Ionic 7 Angular 16 Capacitor 5 SQLite CRUD operations.
|
|
263
269
|
|
|
264
270
|
- [angular-sqlite-app-starter](https://github.com/jepiqueau/angular-sqlite-app-starter) This one is now more for testing the issues.
|
|
265
271
|
|
|
@@ -279,6 +285,10 @@ npm install --save-dev @types/sqlite3
|
|
|
279
285
|
|
|
280
286
|
- [react-vite-sqlite-app](https://github.com/jepiqueau/react-vite-sqlite-app)
|
|
281
287
|
|
|
288
|
+
### Ionic/React Capacitor SQLite + TypeORM Example App
|
|
289
|
+
|
|
290
|
+
- [capacitor-sqlite-react-typeorm-app](https://github.com/cosentino/capacitor-sqlite-react-typeorm-app)
|
|
291
|
+
|
|
282
292
|
### Ionic/Vue
|
|
283
293
|
|
|
284
294
|
- [Ionic/Vue Usage Documentation](https://github.com/capacitor-community/sqlite/blob/master/docs/Ionic-Vue-Usage.md)
|
|
@@ -305,9 +315,9 @@ npm install --save-dev @types/sqlite3
|
|
|
305
315
|
## Dependencies
|
|
306
316
|
|
|
307
317
|
The iOS and Android codes are using `SQLCipher` allowing for database encryption.
|
|
308
|
-
The iOS codes is using `ZIPFoundation` for unzipping assets files
|
|
309
|
-
The Electron code is using `
|
|
310
|
-
The Web code is using the Stencil component `jeep-sqlite` based on `sql.js`, `localforage
|
|
318
|
+
The iOS codes is using `ZIPFoundation` for unzipping assets files
|
|
319
|
+
The Electron code is using `@journeyapps/sqlcipher` and `node-fetch` from 4.2.0.
|
|
320
|
+
The Web code is using the Stencil component `jeep-sqlite` based on `sql.js`, `localforage`. and `jszip`
|
|
311
321
|
|
|
312
322
|
## Contributors ✨
|
|
313
323
|
|
|
@@ -351,6 +361,8 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
|
|
|
351
361
|
<a href="https://github.com/patdx" title="patdx"><img src="https://github.com/patdx.png?size=100" width="50" height="50" /></a>
|
|
352
362
|
<a href="https://github.com/folsze" title="folsze"><img src="https://github.com/folsze.png?size=100" width="50" height="50" /></a>
|
|
353
363
|
<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>
|
|
364
|
+
<a href="https://github.com/beligatclement" title="beligatclement"><img src="https://github.com/beligatclement.png?size=100" width="50" height="50" /></a>
|
|
365
|
+
<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>
|
|
354
366
|
</p>
|
|
355
367
|
|
|
356
368
|
|
package/android/build.gradle
CHANGED
|
@@ -51,12 +51,6 @@ repositories {
|
|
|
51
51
|
mavenCentral()
|
|
52
52
|
}
|
|
53
53
|
|
|
54
|
-
gradle.projectsEvaluated {
|
|
55
|
-
tasks.withType(JavaCompile) {
|
|
56
|
-
options.compilerArgs << "-Xlint:deprecation"
|
|
57
|
-
options.compilerArgs << "-Xlint:unchecked"
|
|
58
|
-
}
|
|
59
|
-
}
|
|
60
54
|
|
|
61
55
|
dependencies {
|
|
62
56
|
implementation fileTree(dir: 'libs', include: ['*.jar'])
|
|
@@ -74,4 +68,3 @@ dependencies {
|
|
|
74
68
|
implementation "androidx.biometric:biometric:1.1.0"
|
|
75
69
|
annotationProcessor 'androidx.room:room-compiler:2.5.1'
|
|
76
70
|
}
|
|
77
|
-
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
|
|
2
|
+
>
|
|
3
3
|
</manifest>
|