dexie 4.4.0 → 4.4.2
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 +39 -5
- package/dist/README.md +46 -0
- package/dist/dexie.d.ts +4 -4
- package/dist/dexie.js +1404 -929
- package/dist/dexie.js.map +1 -1
- package/dist/dexie.min.js +1 -1
- package/dist/dexie.min.js.map +1 -1
- package/dist/dexie.mjs +1404 -929
- package/dist/dexie.mjs.map +1 -1
- package/dist/modern/dexie.min.mjs +1 -1
- package/dist/modern/dexie.min.mjs.map +1 -1
- package/dist/modern/dexie.mjs +1249 -858
- package/dist/modern/dexie.mjs.map +1 -1
- package/package.json +6 -3
- package/testmuai-logo-white.svg +33 -0
- package/testmuai-logo.svg +33 -0
package/README.md
CHANGED
|
@@ -12,7 +12,7 @@ But also:
|
|
|
12
12
|
|
|
13
13
|
* Dexie.js is widely used by 100,000 of web sites, apps and other projects and supports all browsers, Electron for Desktop apps, Capacitor for iOS / Android apps and of course pure PWAs.
|
|
14
14
|
* Dexie.js works around bugs in the IndexedDB implementations, giving a more stable user experience.
|
|
15
|
-
*
|
|
15
|
+
* Need sync? [Dexie Cloud](https://dexie.org/cloud/) adds real-time sync, auth, and collaboration on top of Dexie.js — no backend needed.
|
|
16
16
|
|
|
17
17
|
#### Hello World (vanilla JS)
|
|
18
18
|
|
|
@@ -213,11 +213,39 @@ This is a mix of methods from [WhereClause](https://dexie.org/docs/WhereClause/W
|
|
|
213
213
|
|
|
214
214
|
## Dexie Cloud
|
|
215
215
|
|
|
216
|
-
[Dexie Cloud](https://dexie.org/cloud/) is
|
|
216
|
+
[Dexie Cloud](https://dexie.org/cloud/) is the easiest way to add sync, authentication, and real-time collaboration to your Dexie app. You keep writing frontend code with Dexie.js — Dexie Cloud handles the rest.
|
|
217
217
|
|
|
218
|
-
|
|
218
|
+
**What you get:**
|
|
219
|
+
- 🔄 **Sync across devices** — changes propagate in real time, no polling needed
|
|
220
|
+
- 🔐 **Authentication** — built-in user auth, no identity provider required
|
|
221
|
+
- 🛡️ **Access control** — share data between users with fine-grained permissions
|
|
222
|
+
- 📁 **File & blob storage** — store attachments alongside your structured data
|
|
223
|
+
- ✈️ **Offline-first** — works fully offline, syncs when back online
|
|
219
224
|
|
|
220
|
-
|
|
225
|
+
**Getting started is just a few lines:**
|
|
226
|
+
|
|
227
|
+
```bash
|
|
228
|
+
npm install dexie-cloud-addon
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
```ts
|
|
232
|
+
import Dexie from 'dexie';
|
|
233
|
+
import dexieCloud from 'dexie-cloud-addon';
|
|
234
|
+
|
|
235
|
+
const db = new Dexie('MyDatabase', { addons: [dexieCloud] });
|
|
236
|
+
db.version(1).stores({ items: '@id, title' });
|
|
237
|
+
db.cloud.configure({ databaseUrl: 'https://<your-db>.dexie.cloud' });
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
That's it. Your existing Dexie app now syncs. Hosted cloud or self-hosted on your own infrastructure. 👋
|
|
241
|
+
|
|
242
|
+
→ [Quickstart guide](https://dexie.org/cloud/docs/quickstart)
|
|
243
|
+
|
|
244
|
+
**Sample app:**
|
|
245
|
+
|
|
246
|
+
Source: [Dexie Cloud To-do app](https://github.com/dexie/Dexie.js/tree/master/samples/dexie-cloud-todo-app)
|
|
247
|
+
|
|
248
|
+
Live demo: https://dexie.github.io/Dexie.js/dexie-cloud-todo-app/
|
|
221
249
|
|
|
222
250
|
## Samples
|
|
223
251
|
|
|
@@ -284,7 +312,13 @@ pnpm run watch
|
|
|
284
312
|
|
|
285
313
|
<br/>
|
|
286
314
|
|
|
287
|
-
|
|
315
|
+
Browser testing via<br/>
|
|
316
|
+
<a href="https://www.testmuai.com/?utm_medium=sponsor&utm_source=dexiejs">
|
|
317
|
+
<picture>
|
|
318
|
+
<source media="(prefers-color-scheme: dark)" srcset="testmuai-logo-white.svg">
|
|
319
|
+
<img src="testmuai-logo.svg" alt="TestMu AI (Formerly LambdaTest)" width="147" height="26">
|
|
320
|
+
</picture>
|
|
321
|
+
</a>
|
|
288
322
|
|
|
289
323
|
[npm-image]: https://img.shields.io/npm/v/dexie.svg?style=flat
|
|
290
324
|
[npm-url]: https://npmjs.org/package/dexie
|
package/dist/README.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
## Can't find dexie.js?
|
|
2
|
+
Dexie's dist files are no longer checked in to github except temporarily when tagging
|
|
3
|
+
a release version (just so that bower will continue to work). The reason for this is because
|
|
4
|
+
checking in dist files bloats the commit history and makes it error prone to contribute to the
|
|
5
|
+
repo. To support bower though, we have to continue checking in dist files when releasing,
|
|
6
|
+
but that is now handled by the release.sh script, who also removes them directly afterwards.
|
|
7
|
+
|
|
8
|
+
If you still just want to download dexie.js to include in a test HTML page, go
|
|
9
|
+
to the following download site:
|
|
10
|
+
|
|
11
|
+
### Download
|
|
12
|
+
[dexie.min.js](https://unpkg.com/dexie/dist/dexie.min.js)
|
|
13
|
+
|
|
14
|
+
[dexie.min.js.map](https://unpkg.com/dexie/dist/dexie.min.js.map)
|
|
15
|
+
|
|
16
|
+
### Typings
|
|
17
|
+
[dexie.d.ts](https://unpkg.com/dexie/dist/dexie.d.ts)
|
|
18
|
+
|
|
19
|
+
### Optional Stuff
|
|
20
|
+
[dexie.js (non-minified version)](https://unpkg.com/dexie/dist/dexie.js)
|
|
21
|
+
|
|
22
|
+
[dexie.js.map](https://unpkg.com/dexie/dist/dexie.js.map)
|
|
23
|
+
|
|
24
|
+
[dexie.min.js.gz (Minified and gzipped)](https://unpkg.com/dexie/dist/dexie.min.js.gz)
|
|
25
|
+
|
|
26
|
+
## Install from NPM
|
|
27
|
+
```
|
|
28
|
+
npm install dexie
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## How to build
|
|
32
|
+
1. cd to dexie package
|
|
33
|
+
2. npm install
|
|
34
|
+
3. npm run build
|
|
35
|
+
|
|
36
|
+
## Contributing to Dexie.js?
|
|
37
|
+
|
|
38
|
+
Watch:
|
|
39
|
+
```
|
|
40
|
+
npm run watch
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Test:
|
|
44
|
+
```
|
|
45
|
+
npm test
|
|
46
|
+
```
|
package/dist/dexie.d.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
*
|
|
5
5
|
* By David Fahlander, david.fahlander@gmail.com
|
|
6
6
|
*
|
|
7
|
-
* Version 4.4.
|
|
7
|
+
* Version 4.4.2, Tue Mar 31 2026
|
|
8
8
|
*
|
|
9
9
|
* https://dexie.org
|
|
10
10
|
*
|
|
@@ -50,10 +50,10 @@ export interface DexieEventSet {
|
|
|
50
50
|
(eventName: string): DexieEvent; // To be able to unsubscribe.
|
|
51
51
|
addEventType(eventName: string, chainFunction?: (f1: Function, f2: Function) => Function, defaultFunction?: Function): DexieEvent;
|
|
52
52
|
addEventType(events: {
|
|
53
|
-
[eventName: string]:
|
|
53
|
+
[eventName: string]: "asap" | [
|
|
54
54
|
(f1: Function, f2: Function) => Function,
|
|
55
55
|
Function
|
|
56
|
-
]
|
|
56
|
+
];
|
|
57
57
|
}): DexieEvent;
|
|
58
58
|
}
|
|
59
59
|
export interface TransactionEvents extends DexieEventSet {
|
|
@@ -601,7 +601,7 @@ export interface DBCorePutRequest {
|
|
|
601
601
|
keys: any[];
|
|
602
602
|
changeSpecs: {
|
|
603
603
|
[keyPath: string]: any;
|
|
604
|
-
}[]; // changeSpec per key.
|
|
604
|
+
}[]; // changeSpec per key.
|
|
605
605
|
};
|
|
606
606
|
/** @deprecated Will always get results since 3.1.0-alpha.5 */
|
|
607
607
|
wantResults?: boolean;
|