dexie 3.2.0-rc.2 → 3.2.1-beta.2

package/CONTRIBUTING.md

@@ -6,7 +6,7 @@ We appreciate contributions in forms of:
 * issues
 * help answering questions in [issues](https://github.com/dfahlander/Dexie.js/issues) and on [stackoverflow](https://stackexchange.com/filters/233583/dexie-stackoverflow)
 * fixing bugs via pull-requests
-* developing addons or other [derived work](http://dexie.org/docs/DerivedWork)
+* developing addons or other [derived work](https://dexie.org/docs/DerivedWork)
 * promoting Dexie.js
 * sharing ideas
 

package/README.md

@@ -1,9 +1,9 @@
 Dexie.js
 ========
 
-[![NPM Version][npm-image]][npm-url] [![Build Status](https://travis-ci.com/dfahlander/Dexie.js.svg?branch=master)](https://travis-ci.com/dfahlander/Dexie.js)[![Tested with Browserstack](http://dexie.org/assets/images/tested-with-browserstack2.png)](https://www.browserstack.com)
+[![NPM Version][npm-image]][npm-url] [![Build Status](https://travis-ci.com/dfahlander/Dexie.js.svg?branch=master)](https://travis-ci.com/dfahlander/Dexie.js)[![Tested with Browserstack](https://dexie.org/assets/images/tested-with-browserstack2.png)](https://www.browserstack.com)
 
-Dexie.js is a wrapper library for indexedDB - the standard database in the browser. http://dexie.org
+Dexie.js is a wrapper library for indexedDB - the standard database in the browser. https://dexie.org
 
 #### Why?
 Dexie solves three main issues with the native IndexedDB API:
@@ -44,17 +44,48 @@ Dexie provides a neat database API with a well thought-through API design, robus
  </head>
 </html>
 ```
-Yes, it's that simple.
+Yes, it's that simple. 
 
-[Tutorial](http://dexie.org/docs/Tutorial)
+An equivalent modern version (works in all modern browsers):
 
-[API Reference](http://dexie.org/docs/API-Reference)
+```html
+<!doctype html>
+<html>
+ <head>
+  <script type="module">
+   import Dexie from "https://unpkg.com/dexie@latest/dist/modern/dexie.mjs";
+   //
+   // Declare Database
+   //
+   const db = new Dexie("FriendDatabase");
+   db.version(1).stores({
+     friends: "++id,name,age"
+   });
 
-[Samples](http://dexie.org/docs/Samples)
+   //
+   // Manipulate and Query Database
+   //
+   try {
+     await db.friends.add({name: "Josephine", age: 21});
+     const youngFriends = await db.friends.where("age").below(25).toArray();
+     alert (`My young friends: ${JSON.stringify(youngFriends)}`);
+   } catch (e) {
+     alert (`Error: ${e}`);
+   }
+  </script>
+ </head>
+</html>
+```
+
+[Tutorial](https://dexie.org/docs/Tutorial)
+
+[API Reference](https://dexie.org/docs/API-Reference)
+
+[Samples](https://dexie.org/docs/Samples)
 
 ### Performance
 
-Dexie has kick-ass performance. Its [bulk methods](http://dexie.org/docs/Table/Table.bulkPut()) take advantage of a lesser-known feature in IndexedDB that makes it possible to store stuff without listening to every onsuccess event. This speeds up the performance to a maximum.
+Dexie has kick-ass performance. Its [bulk methods](https://dexie.org/docs/Table/Table.bulkPut()) take advantage of a lesser-known feature in IndexedDB that makes it possible to store stuff without listening to every onsuccess event. This speeds up the performance to a maximum.
 
 #### Supported operations
 ```js
@@ -108,42 +139,12 @@ uniqueKeys(): Promise;
 until(filter: (value) => boolean, includeStopEntry?: boolean): Collection;
 update(key: Key, changes: { [keyPath: string]: any }): Promise;
 ```
-This is a mix of methods from [WhereClause](http://dexie.org/docs/WhereClause/WhereClause), [Table](http://dexie.org/docs/Table/Table) and [Collection](http://dexie.org/docs/Collection/Collection). Dive into the [API reference](http://dexie.org/docs/API-Reference) to see the details.
-
-#### Hello World (ES2016 / ES7)
-```js
-import Dexie from 'dexie';
-
-//
-// Declare Database
-//
-const db = new Dexie("FriendDatabase");
-db.version(1).stores({ friends: "++id,name,age" });
-
-db.transaction('rw', db.friends, async() => {
-
-    // Make sure we have something in DB:
-    if ((await db.friends.where({name: 'Josephine'}).count()) === 0) {
-        const id = await db.friends.add({name: "Josephine", age: 21});
-        alert (`Addded friend with id ${id}`);
-    }
-
-    // Query:
-    const youngFriends = await db.friends.where("age").below(25).toArray();
-
-    // Show result:
-    alert ("My young friends: " + JSON.stringify(youngFriends));
-
-}).catch(e => {
-    alert(e.stack || e);
-});
-
-```
+This is a mix of methods from [WhereClause](https://dexie.org/docs/WhereClause/WhereClause), [Table](https://dexie.org/docs/Table/Table) and [Collection](https://dexie.org/docs/Collection/Collection). Dive into the [API reference](https://dexie.org/docs/API-Reference) to see the details.
 
 #### Hello World (Typescript)
 
 ```js
-import Dexie from 'dexie';
+import Dexie, { Table } from 'dexie';
 
 interface Friend {
     id?: number;
@@ -155,14 +156,13 @@ interface Friend {
 // Declare Database
 //
 class FriendDatabase extends Dexie {
-    public friends: Dexie.Table<Friend, number>; // id is number in this case
+    public friends!: Table<Friend, number>; // id is number in this case
 
     public constructor() {
         super("FriendDatabase");
         this.version(1).stores({
             friends: "++id,name,age"
         });
-        this.friends = this.table("friends");
     }
 }
 
@@ -189,17 +189,17 @@ db.transaction('rw', db.friends, async() => {
 
 Samples
 -------
-http://dexie.org/docs/Samples
+https://dexie.org/docs/Samples
 
 https://github.com/dfahlander/Dexie.js/tree/master/samples
 
 Knowledge Base
 -----
-[http://dexie.org/docs/Questions-and-Answers](http://dexie.org/docs/Questions-and-Answers)
+[https://dexie.org/docs/Questions-and-Answers](https://dexie.org/docs/Questions-and-Answers)
 
 Website
 -------
-[http://dexie.org](http://dexie.org)
+[https://dexie.org](https://dexie.org)
 
 Install over npm
 ----------------
@@ -212,13 +212,21 @@ Download
 --------
 For those who don't like package managers, here's the download links:
 
-https://unpkg.com/dexie@latest/dist/dexie.js
+### Legacy:
+https://unpkg.com/dexie@latest/dist/dexie.min.js
 
-https://unpkg.com/dexie@latest/dist/dexie.js.map
+https://unpkg.com/dexie@latest/dist/dexie.min.js.map
 
+### Modern:
+https://unpkg.com/dexie@latest/dist/modern/dexie.min.mjs
+
+https://unpkg.com/dexie@latest/dist/modern/dexie.min.mjs.map
+
+### Typings:
 https://unpkg.com/dexie@latest/dist/dexie.d.ts
 
 
+
 Contributing
 ============
 Here is a little cheat-sheet for how to symlink your app's `node_modules/dexie` to a place where you can edit the source, version control your changes and create pull requests back to Dexie. Assuming you've already ran `npm install dexie --save` for the app your are developing.

package/dist/dexie.d.ts

@@ -4,13 +4,13 @@
  *
  * By David Fahlander, david.fahlander@gmail.com
  *
- * Version 3.2.0-rc.2, Wed Sep 29 2021
+ * Version 3.2.1-beta.2, Wed Jan 05 2022
  *
- * http://dexie.org
+ * https://dexie.org
  *
  * Apache License Version 2.0, January 2004, http://www.apache.org/licenses/
  */
- // Generated by dts-bundle-generator v5.7.0
+ // Generated by dts-bundle-generator v5.9.0
 
 export interface IndexSpec {
 	name: string;
@@ -551,9 +551,9 @@ export interface DBCoreIndex {
 	readonly name: string | null;
 	/** True if this index represents the primary key */
 	readonly isPrimaryKey?: boolean;
-	/** True if this index represents the primary key and is not inbound (http://dexie.org/docs/inbound) */
+	/** True if this index represents the primary key and is not inbound (https://dexie.org/docs/inbound) */
 	readonly outbound?: boolean;
-	/** True if and only if keyPath is an array (http://dexie.org/docs/Compound-Index) */
+	/** True if and only if keyPath is an array (https://dexie.org/docs/Compound-Index) */
 	readonly compound?: boolean;
 	/** keyPath, null for primary key, string for single-property indexes, Array<string> for compound indexes */
 	readonly keyPath: null | string | string[];
@@ -571,7 +571,6 @@ export interface DBCore {
 	// Transaction and Object Store
 	transaction(stores: string[], mode: "readonly" | "readwrite", options?: DbCoreTransactionOptions): DBCoreTransaction;
 	// Utility methods
-	cmp(a: any, b: any): number;
 	readonly MIN_KEY: any;
 	readonly MAX_KEY: any;
 	readonly schema: DBCoreSchema;
@@ -791,7 +790,7 @@ export interface Dexie extends Database {
  * Common base class for all errors originating from Dexie.js except TypeError,
  * SyntaxError and RangeError.
  *
- * http://dexie.org/docs/DexieErrors/DexieError
+ * https://dexie.org/docs/DexieErrors/DexieError
  *
  */
 export interface DexieError extends Error {
@@ -805,7 +804,7 @@ export interface DexieError extends Error {
  * List of the names of auto-generated error classes that extends DexieError
  * and shares the interface of DexieError.
  *
- * Each error should be documented at http://dexie.org/docs/DexieErrors/Dexie.<errname>
+ * Each error should be documented at https://dexie.org/docs/DexieErrors/Dexie.<errname>
  *
  * The generic type DexieExceptionClasses is a map of full error name to
  * error constructor. The DexieExceptionClasses is mixed in into Dexie,
@@ -825,64 +824,64 @@ export interface DexieError extends Error {
  * }
  */
 export type DexieErrors = {
-	// http://dexie.org/docs/DexieErrors/Dexie.OpenFailedError
+	// https://dexie.org/docs/DexieErrors/Dexie.OpenFailedError
 	OpenFailed: "OpenFailedError";
-	// http://dexie.org/docs/DexieErrors/Dexie.VersionChangeError
+	// https://dexie.org/docs/DexieErrors/Dexie.VersionChangeError
 	VersionChange: "VersionChangeError";
-	// http://dexie.org/docs/DexieErrors/Dexie.SchemaError
+	// https://dexie.org/docs/DexieErrors/Dexie.SchemaError
 	Schema: "SchemaError";
-	// http://dexie.org/docs/DexieErrors/Dexie.UpgradeError
+	// https://dexie.org/docs/DexieErrors/Dexie.UpgradeError
 	Upgrade: "UpgradeError";
-	// http://dexie.org/docs/DexieErrors/Dexie.InvalidTableError
+	// https://dexie.org/docs/DexieErrors/Dexie.InvalidTableError
 	InvalidTable: "InvalidTableError";
-	// http://dexie.org/docs/DexieErrors/Dexie.MissingAPIError
+	// https://dexie.org/docs/DexieErrors/Dexie.MissingAPIError
 	MissingAPI: "MissingAPIError";
-	// http://dexie.org/docs/DexieErrors/Dexie.NoSuchDatabaseError
+	// https://dexie.org/docs/DexieErrors/Dexie.NoSuchDatabaseError
 	NoSuchDatabase: "NoSuchDatabaseError";
-	// http://dexie.org/docs/DexieErrors/Dexie.InvalidArgumentError
+	// https://dexie.org/docs/DexieErrors/Dexie.InvalidArgumentError
 	InvalidArgument: "InvalidArgumentError";
-	// http://dexie.org/docs/DexieErrors/Dexie.SubTransactionError
+	// https://dexie.org/docs/DexieErrors/Dexie.SubTransactionError
 	SubTransaction: "SubTransactionError";
-	// http://dexie.org/docs/DexieErrors/Dexie.UnsupportedError
+	// https://dexie.org/docs/DexieErrors/Dexie.UnsupportedError
 	Unsupported: "UnsupportedError";
-	// http://dexie.org/docs/DexieErrors/Dexie.InternalError
+	// https://dexie.org/docs/DexieErrors/Dexie.InternalError
 	Internal: "InternalError";
-	// http://dexie.org/docs/DexieErrors/Dexie.DatabaseClosedError
+	// https://dexie.org/docs/DexieErrors/Dexie.DatabaseClosedError
 	DatabaseClosed: "DatabaseClosedError";
-	// http://dexie.org/docs/DexieErrors/Dexie.PrematureCommitError
+	// https://dexie.org/docs/DexieErrors/Dexie.PrematureCommitError
 	PrematureCommit: "PrematureCommitError";
-	// http://dexie.org/docs/DexieErrors/Dexie.ForeignAwaitError
+	// https://dexie.org/docs/DexieErrors/Dexie.ForeignAwaitError
 	ForeignAwait: "ForeignAwaitError";
-	// http://dexie.org/docs/DexieErrors/Dexie.UnknownError
+	// https://dexie.org/docs/DexieErrors/Dexie.UnknownError
 	Unknown: "UnknownError";
-	// http://dexie.org/docs/DexieErrors/Dexie.ConstraintError
+	// https://dexie.org/docs/DexieErrors/Dexie.ConstraintError
 	Constraint: "ConstraintError";
-	// http://dexie.org/docs/DexieErrors/Dexie.DataError
+	// https://dexie.org/docs/DexieErrors/Dexie.DataError
 	Data: "DataError";
-	// http://dexie.org/docs/DexieErrors/Dexie.TransactionInactiveError
+	// https://dexie.org/docs/DexieErrors/Dexie.TransactionInactiveError
 	TransactionInactive: "TransactionInactiveError";
-	// http://dexie.org/docs/DexieErrors/Dexie.ReadOnlyError
+	// https://dexie.org/docs/DexieErrors/Dexie.ReadOnlyError
 	ReadOnly: "ReadOnlyError";
-	// http://dexie.org/docs/DexieErrors/Dexie.VersionError
+	// https://dexie.org/docs/DexieErrors/Dexie.VersionError
 	Version: "VersionError";
-	// http://dexie.org/docs/DexieErrors/Dexie.NotFoundError
+	// https://dexie.org/docs/DexieErrors/Dexie.NotFoundError
 	NotFound: "NotFoundError";
-	// http://dexie.org/docs/DexieErrors/Dexie.InvalidStateError
+	// https://dexie.org/docs/DexieErrors/Dexie.InvalidStateError
 	InvalidState: "InvalidStateError";
-	// http://dexie.org/docs/DexieErrors/Dexie.InvalidAccessError
+	// https://dexie.org/docs/DexieErrors/Dexie.InvalidAccessError
 	InvalidAccess: "InvalidAccessError";
-	// http://dexie.org/docs/DexieErrors/Dexie.AbortError
+	// https://dexie.org/docs/DexieErrors/Dexie.AbortError
 	Abort: "AbortError";
-	// http://dexie.org/docs/DexieErrors/Dexie.TimeoutError
+	// https://dexie.org/docs/DexieErrors/Dexie.TimeoutError
 	Timeout: "TimeoutError";
-	// http://dexie.org/docs/DexieErrors/Dexie.QuotaExceededError
+	// https://dexie.org/docs/DexieErrors/Dexie.QuotaExceededError
 	QuotaExceeded: "QuotaExceededError";
-	// http://dexie.org/docs/DexieErrors/Dexie.DataCloneError
+	// https://dexie.org/docs/DexieErrors/Dexie.DataCloneError
 	DataClone: "DataCloneError";
 };
 /** ModifyError
  *
- * http://dexie.org/docs/DexieErrors/Dexie.ModifyError
+ * https://dexie.org/docs/DexieErrors/Dexie.ModifyError
  */
 export interface ModifyError extends DexieError {
 	failures: Array<any>;
@@ -891,7 +890,7 @@ export interface ModifyError extends DexieError {
 }
 /** BulkError
  *
- * http://dexie.org/docs/DexieErrors/Dexie.BulkError
+ * https://dexie.org/docs/DexieErrors/Dexie.BulkError
  */
 export interface BulkError extends DexieError {
 	failures: Error[];
@@ -926,9 +925,15 @@ export interface DexieDOMDependencies {
 	indexedDB: IDBFactory;
 	IDBKeyRange: typeof IDBKeyRange;
 }
+declare global {
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
 export interface Observable<T = any> {
 	subscribe(onNext?: ((value: T) => void) | null, onError?: ((error: any) => void) | null, onComplete?: (() => void) | null): Subscription;
 	subscribe(observer?: Observer<T> | null): Subscription;
+	[Symbol.observable]: () => Observable<T>;
 }
 export interface Subscription {
 	unsubscribe(): void;