dexie 4.0.1-beta.6 → 4.0.1-beta.8

package/dist/dexie.d.ts

@@ -4,7 +4,7 @@
  *
  * By David Fahlander, david.fahlander@gmail.com
  *
- * Version 4.0.1-beta.6, Mon Dec 18 2023
+ * Version 4.0.1-beta.8, Wed Feb 07 2024
  *
  * https://dexie.org
  *
@@ -1120,7 +1120,7 @@ export type InsertType<T, OptionalProps extends keyof T> = Omit<T, OptionalProps
 export type IDType<T, TKeyPropNameOrKeyType> = IsStrictlyAny<T> extends true ? TKeyPropNameOrKeyType : TKeyPropNameOrKeyType extends string ? TKeyPropNameOrKeyType extends keyof T ? T[TKeyPropNameOrKeyType] : TKeyPropNameOrKeyType : TKeyPropNameOrKeyType;
 export type EntityTable<T, TKeyPropName extends keyof T = never, TInsertType = InsertType<T, TKeyPropName>> = Table<T, IDType<T, TKeyPropName>, TInsertType>;
 export declare var Dexie: DexieConstructor;
-export interface _Table<T, TKey> extends Table<T, TKey> {
+export interface _Table<T, TKey, TInsertType> extends Table<T, TKey, TInsertType> {
 }
 export interface _Collection<T, TKey> extends Collection<T, TKey> {
 }
@@ -1128,7 +1128,7 @@ export declare module Dexie {
 	// The "Dexie.Promise" type.
 	type Promise<T = any> = PromiseExtended<T>; // Because many samples have been Dexie.Promise.
 	// The "Dexie.Table" interface. Same as named exported interface Table.
-	interface Table<T = any, Key = any> extends _Table<T, Key> {
+	interface Table<T = any, Key = any, TInsertType = T> extends _Table<T, Key, TInsertType> {
 	} // Because all samples have been Dexie.Table<...>
 	// The "Dexie.Collection" interface. Same as named exported interface Collection.
 	interface Collection<T = any, Key = any> extends _Collection<T, Key> {

package/dist/dexie.js

@@ -4,7 +4,7 @@
  *
  * By David Fahlander, david.fahlander@gmail.com
  *
- * Version 4.0.1-beta.6, Mon Dec 18 2023
+ * Version 4.0.1-beta.8, Wed Feb 07 2024
  *
  * https://dexie.org
  *
@@ -232,7 +232,7 @@
     function flatten(a) {
         return concat.apply([], a);
     }
-    var intrinsicTypeNames = "Array,Boolean,String,Date,RegExp,Blob,File,FileList,FileSystemFileHandle,FileSystemDirectoryHandle,ArrayBuffer,DataView,Uint8ClampedArray,ImageBitmap,ImageData,Map,Set,CryptoKey"
+    var intrinsicTypeNames = "BigUint64Array,BigInt64Array,Array,Boolean,String,Date,RegExp,Blob,File,FileList,FileSystemFileHandle,FileSystemDirectoryHandle,ArrayBuffer,DataView,Uint8ClampedArray,ImageBitmap,ImageData,Map,Set,CryptoKey"
         .split(',').concat(flatten([8, 16, 32, 64].map(function (num) { return ["Int", "Uint", "Float"].map(function (t) { return t + num + "Array"; }); }))).filter(function (t) { return _global[t]; });
     var intrinsicTypes = new Set(intrinsicTypeNames.map(function (t) { return _global[t]; }));
     function cloneSimpleObjectTree(o) {
@@ -1235,7 +1235,7 @@
                 return rejection(new exceptions.DatabaseClosed(db._state.dbOpenError));
             }
             if (!db._state.isBeingOpened) {
-                if (!db._options.autoOpen)
+                if (!db._state.autoOpen)
                     return rejection(new exceptions.DatabaseClosed());
                 db.open().catch(nop);
             }
@@ -1271,7 +1271,7 @@
         }
     }
 
-    var DEXIE_VERSION = '4.0.1-beta.6';
+    var DEXIE_VERSION = '4.0.1-beta.8';
     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>.";
@@ -1454,7 +1454,7 @@
                     .equals(keyPathsInValidOrder.map(function (kp) { return indexOrCrit[kp]; }));
             }
             if (!compoundIndex && debug)
-                console.warn("The query ".concat(JSON.stringify(indexOrCrit), " on ").concat(this.name, " would benefit of a ") +
+                console.warn("The query ".concat(JSON.stringify(indexOrCrit), " on ").concat(this.name, " would benefit from a ") +
                     "compound index [".concat(keyPaths.join('+'), "]"));
             var idxByName = this.schema.idxByName;
             var idb = this.db._deps.indexedDB;
@@ -3410,6 +3410,10 @@
     }
     function runUpgraders(db, oldVersion, idbUpgradeTrans, reject) {
         var globalSchema = db._dbSchema;
+        if (idbUpgradeTrans.objectStoreNames.contains('$meta') && !globalSchema.$meta) {
+            globalSchema.$meta = createTableSchema("$meta", parseIndexSyntax("")[0], []);
+            db._storeNames.push('$meta');
+        }
         var trans = db._createTransaction('readwrite', db._storeNames, globalSchema);
         trans.create(idbUpgradeTrans);
         trans._completion.catch(reject);
@@ -3425,16 +3429,60 @@
                 generateMiddlewareStacks(db, idbUpgradeTrans);
                 DexiePromise.follow(function () { return db.on.populate.fire(trans); }).catch(rejectTransaction);
             }
-            else
-                updateTablesAndIndexes(db, oldVersion, trans, idbUpgradeTrans).catch(rejectTransaction);
+            else {
+                generateMiddlewareStacks(db, idbUpgradeTrans);
+                return getExistingVersion(db, trans, oldVersion)
+                    .then(function (oldVersion) { return updateTablesAndIndexes(db, oldVersion, trans, idbUpgradeTrans); })
+                    .catch(rejectTransaction);
+            }
         });
     }
+    function patchCurrentVersion(db, idbUpgradeTrans) {
+        createMissingTables(db._dbSchema, idbUpgradeTrans);
+        if (idbUpgradeTrans.db.version % 10 === 0 && !idbUpgradeTrans.objectStoreNames.contains('$meta')) {
+            idbUpgradeTrans.db.createObjectStore('$meta').add(Math.ceil((idbUpgradeTrans.db.version / 10) - 1), 'version');
+        }
+        var globalSchema = buildGlobalSchema(db, db.idbdb, idbUpgradeTrans);
+        adjustToExistingIndexNames(db, db._dbSchema, idbUpgradeTrans);
+        var diff = getSchemaDiff(globalSchema, db._dbSchema);
+        var _loop_1 = function (tableChange) {
+            if (tableChange.change.length || tableChange.recreate) {
+                console.warn("Unable to patch indexes of table ".concat(tableChange.name, " because it has changes on the type of index or primary key."));
+                return { value: void 0 };
+            }
+            var store = idbUpgradeTrans.objectStore(tableChange.name);
+            tableChange.add.forEach(function (idx) {
+                if (debug)
+                    console.debug("Dexie upgrade patch: Creating missing index ".concat(tableChange.name, ".").concat(idx.src));
+                addIndex(store, idx);
+            });
+        };
+        for (var _i = 0, _a = diff.change; _i < _a.length; _i++) {
+            var tableChange = _a[_i];
+            var state_1 = _loop_1(tableChange);
+            if (typeof state_1 === "object")
+                return state_1.value;
+        }
+    }
+    function getExistingVersion(db, trans, oldVersion) {
+        if (trans.storeNames.includes('$meta')) {
+            return trans.table('$meta').get('version').then(function (metaVersion) {
+                return metaVersion != null ? metaVersion : oldVersion;
+            });
+        }
+        else {
+            return DexiePromise.resolve(oldVersion);
+        }
+    }
     function updateTablesAndIndexes(db, oldVersion, trans, idbUpgradeTrans) {
         var queue = [];
         var versions = db._versions;
         var globalSchema = db._dbSchema = buildGlobalSchema(db, db.idbdb, idbUpgradeTrans);
         var anyContentUpgraderHasRun = false;
         var versToRun = versions.filter(function (v) { return v._cfg.version >= oldVersion; });
+        if (versToRun.length === 0) {
+            return DexiePromise.resolve();
+        }
         versToRun.forEach(function (version) {
             queue.push(function () {
                 var oldSchema = globalSchema;
@@ -3499,6 +3547,18 @@
                 setApiOnPlace(db, [db.Transaction.prototype], db._storeNames, db._dbSchema);
                 trans.schema = db._dbSchema;
             });
+            queue.push(function (idbtrans) {
+                if (db.idbdb.objectStoreNames.contains('$meta')) {
+                    if (Math.ceil(db.idbdb.version / 10) === version._cfg.version) {
+                        db.idbdb.deleteObjectStore('$meta');
+                        delete db._dbSchema.$meta;
+                        db._storeNames = db._storeNames.filter(function (name) { return name !== '$meta'; });
+                    }
+                    else {
+                        idbtrans.objectStore('$meta').put(version._cfg.version, 'version');
+                    }
+                }
+            });
         });
         function runQueue() {
             return queue.length ? DexiePromise.resolve(queue.shift()(trans.idbtrans)).then(runQueue) :
@@ -3573,6 +3633,8 @@
     function createMissingTables(newSchema, idbtrans) {
         keys(newSchema).forEach(function (tableName) {
             if (!idbtrans.db.objectStoreNames.contains(tableName)) {
+                if (debug)
+                    console.debug('Dexie: Creating missing table', tableName);
                 createTable(idbtrans, tableName, newSchema[tableName].primKey, newSchema[tableName].indexes);
             }
         });
@@ -3591,7 +3653,7 @@
         dbStoreNames.forEach(function (storeName) {
             var store = tmpTrans.objectStore(storeName);
             var keyPath = store.keyPath;
-            var primKey = createIndexSpec(nameFromKeyPath(keyPath), keyPath || "", false, false, !!store.autoIncrement, keyPath && typeof keyPath !== "string", true);
+            var primKey = createIndexSpec(nameFromKeyPath(keyPath), keyPath || "", true, false, !!store.autoIncrement, keyPath && typeof keyPath !== "string", true);
             var indexes = [];
             for (var j = 0; j < store.indexNames.length; ++j) {
                 var idbindex = store.index(store.indexNames[j]);
@@ -3658,6 +3720,7 @@
                 if (stores[tableName] !== null) {
                     var indexes = parseIndexSyntax(stores[tableName]);
                     var primKey = indexes.shift();
+                    primKey.unique = true;
                     if (primKey.multi)
                         throw new exceptions.Schema("Primary key cannot be multi-valued");
                     indexes.forEach(function (idx) {
@@ -3941,7 +4004,7 @@
     }
 
     function obsSetsOverlap(os1, os2) {
-        return Object.keys(os1).some(function (key) { return os2[key] && rangesOverlap(os2[key], os1[key]); });
+        return os1.all || os2.all || Object.keys(os1).some(function (key) { return os2[key] && rangesOverlap(os2[key], os1[key]); });
     }
 
     var cache = {};
@@ -3963,13 +4026,21 @@
     function signalSubscribersNow(updatedParts, deleteAffectedCacheEntries) {
         if (deleteAffectedCacheEntries === void 0) { deleteAffectedCacheEntries = false; }
         var queriesToSignal = new Set();
-        for (var key in updatedParts) {
-            var parts = /^idb\:\/\/(.*)\/(.*)\//.exec(key);
-            if (parts) {
-                var dbName = parts[1], tableName = parts[2];
-                var tblCache = cache["idb://".concat(dbName, "/").concat(tableName)];
-                if (tblCache)
-                    signalTableSubscribersNow(tblCache, updatedParts, queriesToSignal, deleteAffectedCacheEntries);
+        if (updatedParts.all) {
+            for (var _i = 0, _a = Object.values(cache); _i < _a.length; _i++) {
+                var tblCache = _a[_i];
+                signalTableSubscribersNow(tblCache, updatedParts, queriesToSignal, deleteAffectedCacheEntries);
+            }
+        }
+        else {
+            for (var key in updatedParts) {
+                var parts = /^idb\:\/\/(.*)\/(.*)\//.exec(key);
+                if (parts) {
+                    var dbName = parts[1], tableName = parts[2];
+                    var tblCache = cache["idb://".concat(dbName, "/").concat(tableName)];
+                    if (tblCache)
+                        signalTableSubscribersNow(tblCache, updatedParts, queriesToSignal, deleteAffectedCacheEntries);
+                }
             }
         }
         queriesToSignal.forEach(function (requery) { return requery(); });
@@ -4011,6 +4082,8 @@
         state.dbOpenError = null;
         state.openComplete = false;
         var openCanceller = state.openCanceller;
+        var nativeVerToOpen = Math.round(db.verno * 10);
+        var schemaPatchMode = false;
         function throwIfCancelled() {
             if (state.openCanceller !== openCanceller)
                 throw new exceptions.DatabaseClosed('db.open() was cancelled');
@@ -4022,9 +4095,9 @@
             if (!indexedDB)
                 throw new exceptions.MissingAPI();
             var dbName = db.name;
-            var req = state.autoSchema ?
+            var req = state.autoSchema || !nativeVerToOpen ?
                 indexedDB.open(dbName) :
-                indexedDB.open(dbName, Math.round(db.verno * 10));
+                indexedDB.open(dbName, nativeVerToOpen);
             if (!req)
                 throw new exceptions.MissingAPI();
             req.onerror = eventRejectHandler(reject);
@@ -4045,6 +4118,9 @@
                     var oldVer = e.oldVersion > Math.pow(2, 62) ? 0 : e.oldVersion;
                     wasCreated = oldVer < 1;
                     db.idbdb = req.result;
+                    if (schemaPatchMode) {
+                        patchCurrentVersion(db, upgradeTransaction);
+                    }
                     runUpgraders(db, oldVer / 10, upgradeTransaction, reject);
                 }
             }, reject);
@@ -4059,8 +4135,12 @@
                             readGlobalSchema(db, idbdb, tmpTrans);
                         else {
                             adjustToExistingIndexNames(db, db._dbSchema, tmpTrans);
-                            if (!verifyInstalledSchema(db, tmpTrans)) {
-                                console.warn("Dexie SchemaDiff: Schema was extended without increasing the number passed to db.version(). Some queries may fail.");
+                            if (!verifyInstalledSchema(db, tmpTrans) && !schemaPatchMode) {
+                                console.warn("Dexie SchemaDiff: Schema was extended without increasing the number passed to db.version(). Dexie will add missing parts and increment native version number to workaround this.");
+                                idbdb.close();
+                                nativeVerToOpen = idbdb.version + 1;
+                                schemaPatchMode = true;
+                                return resolve(tryOpenDB());
                             }
                         }
                         generateMiddlewareStacks(db, tmpTrans);
@@ -4080,14 +4160,22 @@
                 resolve();
             }, reject);
         }).catch(function (err) {
-            if (err && err.name === 'UnknownError' && state.PR1398_maxLoop > 0) {
-                state.PR1398_maxLoop--;
-                console.warn('Dexie: Workaround for Chrome UnknownError on open()');
-                return tryOpenDB();
-            }
-            else {
-                return DexiePromise.reject(err);
+            switch (err === null || err === void 0 ? void 0 : err.name) {
+                case "UnknownError":
+                    if (state.PR1398_maxLoop > 0) {
+                        state.PR1398_maxLoop--;
+                        console.warn('Dexie: Workaround for Chrome UnknownError on open()');
+                        return tryOpenDB();
+                    }
+                    break;
+                case "VersionError":
+                    if (nativeVerToOpen > 0) {
+                        nativeVerToOpen = 0;
+                        return tryOpenDB();
+                    }
+                    break;
             }
+            return DexiePromise.reject(err);
         }); };
         return DexiePromise.race([
             openCanceller,
@@ -4811,6 +4899,8 @@
         if (!ops || ops.length === 0)
             return result;
         var index = req.query.index;
+        var multiEntry = index.multiEntry;
+        var queryRange = req.query.range;
         var primaryKey = table.schema.primaryKey;
         var extractPrimKey = primaryKey.extractKey;
         var extractIndex = index.extractKey;
@@ -4819,7 +4909,10 @@
             var modifedResult = result;
             var includedValues = op.type === 'add' || op.type === 'put'
                 ? op.values.filter(function (v) {
-                    return isWithinRange(extractIndex(v), req.query.range);
+                    var key = extractIndex(v);
+                    return multiEntry && isArray(key)
+                        ? key.some(function (k) { return isWithinRange(k, queryRange); })
+                        : isWithinRange(key, queryRange);
                 }).map(function (v) {
                     v = deepClone(v);
                     if (immutable)
@@ -5198,7 +5291,8 @@
                 cancelOpen: nop,
                 openCanceller: null,
                 autoSchema: true,
-                PR1398_maxLoop: 3
+                PR1398_maxLoop: 3,
+                autoOpen: options.autoOpen,
             };
             state.dbReadyPromise = new DexiePromise(function (resolve) {
                 state.dbReadyResolve = resolve;
@@ -5315,7 +5409,7 @@
                     return reject(new exceptions.DatabaseClosed(_this._state.dbOpenError));
                 }
                 if (!_this._state.isBeingOpened) {
-                    if (!_this._options.autoOpen) {
+                    if (!_this._state.autoOpen) {
                         reject(new exceptions.DatabaseClosed());
                         return;
                     }
@@ -5370,10 +5464,14 @@
         };
         Dexie.prototype.close = function (_a) {
             var _b = _a === void 0 ? { disableAutoOpen: true } : _a, disableAutoOpen = _b.disableAutoOpen;
+            var wasOpen = this.isOpen();
             this._close();
             var state = this._state;
             if (disableAutoOpen)
-                this._options.autoOpen = false;
+                this._state.autoOpen = false;
+            else if (wasOpen && this._options.autoOpen) {
+                this._state.autoOpen = true;
+            }
             state.dbOpenError = new exceptions.DatabaseClosed();
             if (state.isBeingOpened)
                 state.cancelOpen(state.dbOpenError);
@@ -5749,62 +5847,40 @@
     }
     var propagatingLocally = false;
 
+    var bc;
+    var createBC = function () { };
     if (typeof BroadcastChannel !== 'undefined') {
-        var bc_1 = new BroadcastChannel(STORAGE_MUTATED_DOM_EVENT_NAME);
-        if (typeof bc_1.unref === 'function') {
-            bc_1.unref();
+        createBC = function () {
+            bc = new BroadcastChannel(STORAGE_MUTATED_DOM_EVENT_NAME);
+            bc.onmessage = function (ev) { return ev.data && propagateLocally(ev.data); };
+        };
+        createBC();
+        if (typeof bc.unref === 'function') {
+            bc.unref();
         }
         globalEvents(DEXIE_STORAGE_MUTATED_EVENT_NAME, function (changedParts) {
             if (!propagatingLocally) {
-                bc_1.postMessage(changedParts);
+                bc.postMessage(changedParts);
             }
         });
-        bc_1.onmessage = function (ev) {
-            if (ev.data)
-                propagateLocally(ev.data);
-        };
     }
-    else if (typeof self !== 'undefined' && typeof navigator !== 'undefined') {
-        globalEvents(DEXIE_STORAGE_MUTATED_EVENT_NAME, function (changedParts) {
-            try {
-                if (!propagatingLocally) {
-                    if (typeof localStorage !== 'undefined') {
-                        localStorage.setItem(STORAGE_MUTATED_DOM_EVENT_NAME, JSON.stringify({
-                            trig: Math.random(),
-                            changedParts: changedParts,
-                        }));
-                    }
-                    if (typeof self['clients'] === 'object') {
-                        __spreadArray([], self['clients'].matchAll({ includeUncontrolled: true }), true).forEach(function (client) {
-                            return client.postMessage({
-                                type: STORAGE_MUTATED_DOM_EVENT_NAME,
-                                changedParts: changedParts,
-                            });
-                        });
-                    }
-                }
+
+    if (typeof addEventListener !== 'undefined') {
+        addEventListener('pagehide', function (event) {
+            if (event.persisted) {
+                bc === null || bc === void 0 ? void 0 : bc.close();
+            }
+            for (var _i = 0, connections_1 = connections; _i < connections_1.length; _i++) {
+                var db = connections_1[_i];
+                db.close({ disableAutoOpen: false });
+            }
+        });
+        addEventListener('pageshow', function (event) {
+            if (event.persisted) {
+                createBC();
+                propagateLocally({ all: new RangeSet(-Infinity, [[]]) });
             }
-            catch (_a) { }
         });
-        if (typeof addEventListener !== 'undefined') {
-            addEventListener('storage', function (ev) {
-                if (ev.key === STORAGE_MUTATED_DOM_EVENT_NAME) {
-                    var data = JSON.parse(ev.newValue);
-                    if (data)
-                        propagateLocally(data.changedParts);
-                }
-            });
-        }
-        var swContainer = self.document && navigator.serviceWorker;
-        if (swContainer) {
-            swContainer.addEventListener('message', propagateMessageLocally);
-        }
-    }
-    function propagateMessageLocally(_a) {
-        var data = _a.data;
-        if (data && data.type === STORAGE_MUTATED_DOM_EVENT_NAME) {
-            propagateLocally(data.changedParts);
-        }
     }
 
     DexiePromise.rejectionMapper = mapError;