dexie 4.0.1-beta.9 → 4.0.1-rc.1

package/SECURITY.md

@@ -6,7 +6,7 @@
 | ------- | ------------------ | --------
 | 4.x     | :white_check_mark: | master
 | 3.x     | :white_check_mark: | master-3
-| 2.0.x   | :thinking: | master-2
+| 2.0.x   | :x: | master-2
 | 1.5.x   | :x: | master-1
 | < 1.5.1 | :x:                |
 

package/dist/dexie.d.ts

@@ -4,7 +4,7 @@
  *
  * By David Fahlander, david.fahlander@gmail.com
  *
- * Version 4.0.1-beta.9, Thu Feb 08 2024
+ * Version 4.0.1-rc.1, Wed Mar 20 2024
  *
  * https://dexie.org
  *
@@ -363,8 +363,24 @@ export type KeyPaths<T> = {
 	 ? never : T[P] extends object ? P | `${P}.${KeyPaths<T[P]>}` : P : never;
 }[keyof T];
 export type KeyPathValue<T, PATH> = PATH extends `${infer R}.${infer S}` ? R extends keyof T ? KeyPathValue<T[R], S> : T extends any[] ? PATH extends `${number}.${infer S}` ? KeyPathValue<T[number], S> : void : void : PATH extends `${number}` ? T extends any[] ? T[number] : void : PATH extends keyof T ? T[PATH] : void;
+export declare const PropModSymbol: unique symbol;
+export type PropModSpec = {
+	replacePrefix?: [
+		string,
+		string
+	];
+};
+export class PropModification implements PropModSpec {
+	[PropModSymbol]?: true;
+	replacePrefix?: [
+		string,
+		string
+	];
+	execute<T>(value: T): T;
+	constructor(spec: PropModSpec);
+}
 export type UpdateSpec<T> = {
-	[KP in KeyPaths<T>]?: KeyPathValue<T, KP>;
+	[KP in KeyPaths<T>]?: KeyPathValue<T, KP> | PropModification;
 };
 export interface Collection<T = any, TKey = IndexableType, TInsertType = T> {
 	db: Dexie;
@@ -804,7 +820,9 @@ export interface Dexie {
 	close(closeOptions?: {
 		disableAutoOpen: boolean;
 	}): void;
-	delete(): PromiseExtended<void>;
+	delete(closeOptions?: {
+		disableAutoOpen: boolean;
+	}): PromiseExtended<void>;
 	isOpen(): boolean;
 	hasBeenClosed(): boolean;
 	hasFailed(): boolean;
@@ -1068,6 +1086,7 @@ export interface DexieConstructor extends DexieExceptionClasses {
 	getDatabaseNames<R>(thenShortcut: ThenShortcut<string[], R>): Promise<R>;
 	vip<U>(scopeFunction: () => U): U;
 	ignoreTransaction<U>(fn: () => U): U;
+	disableBfCache?: boolean;
 	liveQuery<T>(fn: () => T | Promise<T>): Observable<T>;
 	extendObservabilitySet(target: ObservabilitySet, newSet: ObservabilitySet): ObservabilitySet;
 	override<F>(origFunc: F, overridedFactory: (fn: any) => any): F; // ?
@@ -1137,6 +1156,7 @@ export function liveQuery<T>(querier: () => T | Promise<T>): Observable<T>;
 export function mergeRanges(target: IntervalTree, newSet: IntervalTree): void;
 export function rangesOverlap(rangeSet1: IntervalTree, rangeSet2: IntervalTree): boolean;
 export function cmp(a: any, b: any): number;
+export function replacePrefix(a: string, b: string): PropModification;
 /** Exporting 'Dexie' as the default export.
  **/
 export default Dexie;

package/dist/dexie.js

@@ -4,7 +4,7 @@
  *
  * By David Fahlander, david.fahlander@gmail.com
  *
- * Version 4.0.1-beta.9, Thu Feb 08 2024
+ * Version 4.0.1-rc.1, Wed Mar 20 2024
  *
  * https://dexie.org
  *
@@ -156,7 +156,7 @@
         var period = keyPath.indexOf('.');
         if (period !== -1) {
             var innerObj = obj[keyPath.substr(0, period)];
-            return innerObj === undefined ? undefined : getByKeyPath(innerObj, keyPath.substr(period + 1));
+            return innerObj == null ? undefined : getByKeyPath(innerObj, keyPath.substr(period + 1));
         }
         return undefined;
     }
@@ -1129,7 +1129,7 @@
             catch (ex) {
                 if (ex.name === errnames.InvalidState && db.isOpen() && --db._state.PR1398_maxLoop > 0) {
                     console.warn('Dexie: Need to reopen db');
-                    db._close();
+                    db.close({ disableAutoOpen: false });
                     return db.open().then(function () { return tempTransaction(db, mode, storeNames, fn); });
                 }
                 return rejection(ex);
@@ -1150,15 +1150,12 @@
         }
     }
 
-    var DEXIE_VERSION = '4.0.1-beta.9';
+    var DEXIE_VERSION = '4.0.1-rc.1';
     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>.";
     var STRING_EXPECTED = "String expected.";
     var connections = [];
-    var isIEOrEdge = typeof navigator !== 'undefined' && /(MSIE|Trident|Edge)/.test(navigator.userAgent);
-    var hasIEDeleteObjectStoreBug = isIEOrEdge;
-    var hangsOnDeleteLargeKeyRange = isIEOrEdge;
     var DBNAMES_DB = '__dbnames';
     var READONLY = 'readonly';
     var READWRITE = 'readwrite';
@@ -1806,6 +1803,22 @@
         });
     }
 
+    var PropModSymbol = Symbol();
+    var PropModification =  (function () {
+        function PropModification(spec) {
+            Object.assign(this, spec);
+        }
+        PropModification.prototype.execute = function (value) {
+            var _a;
+            var prefixToReplace = (_a = this.replacePrefix) === null || _a === void 0 ? void 0 : _a[0];
+            if (prefixToReplace && typeof value === 'string' && value.startsWith(prefixToReplace)) {
+                return this.replacePrefix[1] + value.substring(prefixToReplace.length);
+            }
+            return value;
+        };
+        return PropModification;
+    }());
+
     var Collection =  (function () {
         function Collection() {
         }
@@ -2077,8 +2090,14 @@
                     modifyer = function (item) {
                         var anythingModified = false;
                         for (var i = 0; i < numKeys; ++i) {
-                            var keyPath = keyPaths[i], val = changes[keyPath];
-                            if (getByKeyPath(item, keyPath) !== val) {
+                            var keyPath = keyPaths[i];
+                            var val = changes[keyPath];
+                            var origVal = getByKeyPath(item, keyPath);
+                            if (val instanceof PropModification) {
+                                setByKeyPath(item, keyPath, val.execute(origVal));
+                                anythingModified = true;
+                            }
+                            else if (origVal !== val) {
                                 setByKeyPath(item, keyPath, val);
                                 anythingModified = true;
                             }
@@ -2177,7 +2196,7 @@
         Collection.prototype.delete = function () {
             var ctx = this._ctx, range = ctx.range;
             if (isPlainKeyRange(ctx) &&
-                ((ctx.isPrimKey && !hangsOnDeleteLargeKeyRange) || range.type === 3 ))
+                (ctx.isPrimKey || range.type === 3 ))
              {
                 return this._write(function (trans) {
                     var primaryKey = ctx.table.core.schema.primaryKey;
@@ -3367,7 +3386,6 @@
         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();
@@ -3401,7 +3419,6 @@
                 if (contentUpgrade && version._cfg.version > oldVersion) {
                     generateMiddlewareStacks(db, idbUpgradeTrans);
                     trans._memoizedTables = {};
-                    anyContentUpgraderHasRun = true;
                     var upgradeSchema_1 = shallowClone(newSchema);
                     diff.del.forEach(function (table) {
                         upgradeSchema_1[table] = oldSchema[table];
@@ -3428,10 +3445,8 @@
                 }
             });
             queue.push(function (idbtrans) {
-                if (!anyContentUpgraderHasRun || !hasIEDeleteObjectStoreBug) {
-                    var newSchema = version._cfg.dbschema;
-                    deleteRemovedTables(newSchema, idbtrans);
-                }
+                var newSchema = version._cfg.dbschema;
+                deleteRemovedTables(newSchema, idbtrans);
                 removeTablesApi(db, [db.Transaction.prototype]);
                 setApiOnPlace(db, [db.Transaction.prototype], db._storeNames, db._dbSchema);
                 trans.schema = db._dbSchema;
@@ -3484,8 +3499,7 @@
                 };
                 if ((
                 '' + (oldDef.primKey.keyPath || '')) !== ('' + (newDef.primKey.keyPath || '')) ||
-                    (oldDef.primKey.auto !== newDef.primKey.auto && !isIEOrEdge))
-                 {
+                    (oldDef.primKey.auto !== newDef.primKey.auto)) {
                     change.recreate = true;
                     diff.change.push(change);
                 }
@@ -4159,7 +4173,7 @@
                 catch (ex) {
                     if (ex.name === errnames.InvalidState && db.isOpen() && --db._state.PR1398_maxLoop > 0) {
                         console.warn('Dexie: Need to reopen db');
-                        db._close();
+                        db.close({ disableAutoOpen: false });
                         return db.open().then(function () { return enterTransactionScope(db, mode, storeNames, null, scopeFunc); });
                     }
                     return rejection(ex);
@@ -5252,7 +5266,6 @@
                 else
                     console.warn("Another connection wants to delete database '".concat(_this.name, "'. Closing db now to resume the delete request."));
                 _this.close({ disableAutoOpen: false });
-                _this._state.openComplete = false;
             });
             this.on("blocked", function (ev) {
                 if (!ev.newVersion || ev.newVersion < ev.oldVersion)
@@ -5366,34 +5379,42 @@
                 catch (e) { }
                 this.idbdb = null;
             }
-            state.dbReadyPromise = new DexiePromise(function (resolve) {
-                state.dbReadyResolve = resolve;
-            });
-            state.openCanceller = new DexiePromise(function (_, reject) {
-                state.cancelOpen = reject;
-            });
+            if (!state.isBeingOpened) {
+                state.dbReadyPromise = new DexiePromise(function (resolve) {
+                    state.dbReadyResolve = resolve;
+                });
+                state.openCanceller = new DexiePromise(function (_, reject) {
+                    state.cancelOpen = reject;
+                });
+            }
         };
         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._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);
+            if (disableAutoOpen) {
+                if (state.isBeingOpened) {
+                    state.cancelOpen(new exceptions.DatabaseClosed());
+                }
+                this._close();
+                state.autoOpen = false;
+                state.dbOpenError = new exceptions.DatabaseClosed();
+            }
+            else {
+                this._close();
+                state.autoOpen = this._options.autoOpen ||
+                    state.isBeingOpened;
+                state.openComplete = false;
+                state.dbOpenError = null;
+            }
         };
-        Dexie.prototype.delete = function () {
+        Dexie.prototype.delete = function (closeOptions) {
             var _this = this;
-            var hasArguments = arguments.length > 0;
+            if (closeOptions === void 0) { closeOptions = { disableAutoOpen: true }; }
+            var hasInvalidArguments = arguments.length > 0 && typeof arguments[0] !== 'object';
             var state = this._state;
             return new DexiePromise(function (resolve, reject) {
                 var doDelete = function () {
-                    _this.close({ disableAutoOpen: false });
+                    _this.close(closeOptions);
                     var req = _this._deps.indexedDB.deleteDatabase(_this.name);
                     req.onsuccess = wrap(function () {
                         _onDatabaseDeleted(_this._deps, _this.name);
@@ -5402,8 +5423,8 @@
                     req.onerror = eventRejectHandler(reject);
                     req.onblocked = _this._fireOnBlocked;
                 };
-                if (hasArguments)
-                    throw new exceptions.InvalidArgument("Arguments not allowed in db.delete()");
+                if (hasInvalidArguments)
+                    throw new exceptions.InvalidArgument("Invalid closeOptions argument to db.delete()");
                 if (state.isBeingOpened) {
                     state.dbReadyPromise.then(doDelete);
                 }
@@ -5724,15 +5745,9 @@
         globalEvents(DEXIE_STORAGE_MUTATED_EVENT_NAME, function (updatedParts) {
             if (!propagatingLocally) {
                 var event_1;
-                if (isIEOrEdge) {
-                    event_1 = document.createEvent('CustomEvent');
-                    event_1.initCustomEvent(STORAGE_MUTATED_DOM_EVENT_NAME, true, true, updatedParts);
-                }
-                else {
-                    event_1 = new CustomEvent(STORAGE_MUTATED_DOM_EVENT_NAME, {
-                        detail: updatedParts
-                    });
-                }
+                event_1 = new CustomEvent(STORAGE_MUTATED_DOM_EVENT_NAME, {
+                    detail: updatedParts
+                });
                 propagatingLocally = true;
                 dispatchEvent(event_1);
                 propagatingLocally = false;
@@ -5778,22 +5793,30 @@
 
     if (typeof addEventListener !== 'undefined') {
         addEventListener('pagehide', function (event) {
-            if (event.persisted) {
+            if (!Dexie$1.disableBfCache && event.persisted) {
+                if (debug)
+                    console.debug('Dexie: handling persisted pagehide');
                 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 });
+                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) {
+            if (!Dexie$1.disableBfCache && event.persisted) {
+                if (debug)
+                    console.debug('Dexie: handling persisted pageshow');
                 createBC();
                 propagateLocally({ all: new RangeSet(-Infinity, [[]]) });
             }
         });
     }
 
+    function replacePrefix(a, b) {
+        return new PropModification({ replacePrefix: [a, b] });
+    }
+
     DexiePromise.rejectionMapper = mapError;
     setDebug(debug);
 
@@ -5803,6 +5826,9 @@
         liveQuery: liveQuery,
         Entity: Entity,
         cmp: cmp,
+        PropModSymbol: PropModSymbol,
+        PropModification: PropModification,
+        replacePrefix: replacePrefix,
         'default': Dexie$1,
         RangeSet: RangeSet,
         mergeRanges: mergeRanges,