dexie 4.0.0-alpha.1 → 4.0.0-alpha.2

package/README.md

@@ -1,7 +1,7 @@
 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](https://dexie.org/assets/images/tested-with-browserstack2.png)](https://www.browserstack.com)
+[![NPM Version][npm-image]][npm-url] [![Build Status](https://travis-ci.com/dexie/Dexie.js.svg?branch=master)](https://travis-ci.com/dexie/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. https://dexie.org
 
@@ -191,7 +191,7 @@ Samples
 -------
 https://dexie.org/docs/Samples
 
-https://github.com/dfahlander/Dexie.js/tree/master/samples
+https://github.com/dexie/Dexie.js/tree/master/samples
 
 Knowledge Base
 -----

package/dist/dexie.d.ts

@@ -4,7 +4,7 @@
  *
  * By David Fahlander, david.fahlander@gmail.com
  *
- * Version 4.0.0-alpha.1, Sun Dec 19 2021
+ * Version 4.0.0-alpha.2, Sun Apr 10 2022
  *
  * https://dexie.org
  *
@@ -701,9 +701,34 @@ export interface DbEvents extends DexieEventSet {
 	versionchange: DexieVersionChangeEvent;
 	close: DexieCloseEvent;
 }
+/** Set of mutated parts of the database
+ */
 export type ObservabilitySet = {
-	// `idb:${dbName}/${tableName}/changedRowContents` - keys.
-	// `idb:${dbName}/${tableName}/changedIndexes/${indexName}` - indexes
+	/** Database part having been mutated.
+	 *
+	 * This structure is produced in observability-middleware.ts
+	 * and consumed in live-query.ts.
+	 *
+	 * Format of 'part':
+	 *
+	 *   `idb://${dbName}/${tableName}/${indexName}`
+	 *
+	 * * dbName is the database name
+	 * * tableName is the table name
+	 * * indexName is any of:
+	 *    1. An empty string - represents the primary keys of the affected objs
+	 *    2. ":dels" - represents primary keys of deleted objects in the table
+	 *    3. The keyPath of an index, such as "name", "age" or "address.city" -
+	 *       represents indexes that, if used in a query, might affect the
+	 *       result of that query.
+	 *
+	 * IntervalTree
+	 *    * See definition of IntervalTree type in rangeset.d.ts
+	 *    * See rangesOverlap() in rangeset.ts that can be used to compare two
+	 *      IntervalTrees and detect collissions.
+	 *    * See RangeSet class that can be used to create an IntervalTree and add
+	 *      ranges to it.
+	 */
 	[part: string]: IntervalTree;
 };
 export interface DexieOnStorageMutatedEvent {
@@ -747,6 +772,7 @@ export interface Dexie {
 	readonly name: string;
 	readonly tables: Table[];
 	readonly verno: number;
+	/** The 'vip' instance - passed to db.on('ready') and allows usage before db.on('ready') completes. */
 	readonly vip: Dexie;
 	readonly _allTables: {
 		[name: string]: Table<any, IndexableType>;

package/dist/dexie.js

@@ -4,7 +4,7 @@
  *
  * By David Fahlander, david.fahlander@gmail.com
  *
- * Version 4.0.0-alpha.1, Sun Dec 19 2021
+ * Version 4.0.0-alpha.2, Sun Apr 10 2022
  *
  * https://dexie.org
  *
@@ -1300,7 +1300,7 @@
         }
     }
 
-    var DEXIE_VERSION = '4.0.0-alpha.1';
+    var DEXIE_VERSION = '4.0.0-alpha.2';
     var maxString = String.fromCharCode(65535);
     var minKey = -Infinity;
     var INVALID_KEY_ARGUMENT = "Invalid key provided. Keys must be of type string, number, Date or Array<string | number | Date>.";
@@ -3349,20 +3349,19 @@
             if (db.core.schema.tables.some(function (tbl) { return tbl.name === tableName; })) {
                 table.core = db.core.table(tableName);
                 if (db[tableName] instanceof db.Table) {
-                    db[tableName].core = table.core;
+                    db[tableName].core = db.vip[tableName].core = table.core;
                 }
             }
         });
     }
 
-    function setApiOnPlace(_a, objs, tableNames, dbschema) {
-        var db = _a._novip;
+    function setApiOnPlace(objs, tableNames, dbschema) {
         tableNames.forEach(function (tableName) {
             var schema = dbschema[tableName];
             objs.forEach(function (obj) {
                 var propDesc = getPropertyDescriptor(obj, tableName);
-                if (!propDesc || ("value" in propDesc && propDesc.value === undefined)) {
-                    if (obj === db.Transaction.prototype || obj instanceof db.Transaction) {
+                if (!propDesc || ("value" in propDesc && (propDesc.value === undefined || propDesc.value instanceof Table))) {
+                    if (obj instanceof Transaction) {
                         setProp(obj, tableName, {
                             get: function () { return this.table(tableName); },
                             set: function (value) {
@@ -3370,20 +3369,22 @@
                             }
                         });
                     }
-                    else {
-                        obj[tableName] = new db.Table(tableName, schema);
+                    else if (obj instanceof Dexie$1) {
+                        obj._allTables[tableName] = obj[tableName] = new obj.Table(tableName, schema);
                     }
                 }
             });
         });
     }
-    function removeTablesApi(_a, objs) {
-        var db = _a._novip;
+    function removeTablesApi(objs) {
         objs.forEach(function (obj) {
-            for (var key in obj) {
-                if (obj[key] instanceof db.Table)
-                    delete obj[key];
-            }
+            (obj instanceof Dexie$1 ? [obj, obj._allTables] : [obj]).forEach(function (obj) {
+                for (var key in obj) {
+                    if (obj[key] instanceof Table) {
+                        delete obj[key];
+                    }
+                }
+            });
         });
     }
     function lowerVersionFirst(a, b) {
@@ -3451,8 +3452,8 @@
                     diff.del.forEach(function (table) {
                         upgradeSchema_1[table] = oldSchema[table];
                     });
-                    removeTablesApi(db, [db.Transaction.prototype]);
-                    setApiOnPlace(db, [db.Transaction.prototype], keys(upgradeSchema_1), upgradeSchema_1);
+                    removeTablesApi([db.Transaction.prototype]);
+                    setApiOnPlace([db.Transaction.prototype], keys(upgradeSchema_1), upgradeSchema_1);
                     trans.schema = upgradeSchema_1;
                     var contentUpgradeIsAsync_1 = isAsyncFunction(contentUpgrade);
                     if (contentUpgradeIsAsync_1) {
@@ -3477,8 +3478,8 @@
                     var newSchema = version._cfg.dbschema;
                     deleteRemovedTables(newSchema, idbtrans);
                 }
-                removeTablesApi(db, [db.Transaction.prototype]);
-                setApiOnPlace(db, [db.Transaction.prototype], db._storeNames, db._dbSchema);
+                removeTablesApi([db.Transaction.prototype]);
+                setApiOnPlace([db.Transaction.prototype], db._storeNames, db._dbSchema);
                 trans.schema = db._dbSchema;
             });
         });
@@ -3590,7 +3591,7 @@
         db.verno = idbdb.version / 10;
         var globalSchema = db._dbSchema = buildGlobalSchema(db, idbdb, tmpTrans);
         db._storeNames = slice(idbdb.objectStoreNames, 0);
-        setApiOnPlace(db, [db._allTables], keys(globalSchema), globalSchema);
+        setApiOnPlace([db, db.vip], keys(globalSchema), globalSchema);
     }
     function verifyInstalledSchema(db, tmpTrans) {
         var installedSchema = buildGlobalSchema(db, db.idbdb, tmpTrans);
@@ -3655,7 +3656,7 @@
             });
         };
         Version.prototype.stores = function (stores) {
-            var db = this.db;
+            var db = this.db._novip;
             this._cfg.storesSource = this._cfg.storesSource ?
                 extend(this._cfg.storesSource, stores) :
                 stores;
@@ -3668,8 +3669,8 @@
                 version._parseStoresSpec(storesSpec, dbschema);
             });
             db._dbSchema = dbschema;
-            removeTablesApi(db, [db._allTables, db, db.Transaction.prototype]);
-            setApiOnPlace(db, [db._allTables, db, db.Transaction.prototype, this._cfg.tables], keys(dbschema), dbschema);
+            removeTablesApi([db, db.vip, db.Transaction.prototype]);
+            setApiOnPlace([db, db.vip, db.Transaction.prototype], keys(dbschema), dbschema);
             db._storeNames = keys(dbschema);
             return this;
         };
@@ -3687,7 +3688,6 @@
                 version: versionNumber,
                 storesSource: null,
                 dbschema: {},
-                tables: {},
                 contentUpgrade: null
             };
         });
@@ -4712,7 +4712,11 @@
             this.use(hooksMiddleware);
             this.use(observabilityMiddleware);
             this.use(cacheExistingValuesMiddleware);
-            this.vip = Object.create(this, { _vip: { value: true } });
+            var vipDexie = Object.create(this);
+            vipDexie._vip = true;
+            vipDexie.Table = createTableConstructor(vipDexie);
+            vipDexie._allTables = {};
+            this.vip = vipDexie;
             addons.forEach(function (addon) { return addon(_this); });
         }
         Dexie.prototype.version = function (versionNumber) {