dexie 3.2.0-beta.3 → 3.2.0

package/dist/dexie.d.ts

@@ -4,13 +4,13 @@
  *
  * By David Fahlander, david.fahlander@gmail.com
  *
- * Version 3.2.0-beta.3, Mon Aug 02 2021
+ * Version 3.2.0, Thu Nov 18 2021
  *
  * http://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;
@@ -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;
@@ -646,7 +645,7 @@ export interface Table<T = any, TKey = IndexableType> {
 	bulkPut(items: readonly T[], keys?: IndexableTypeArrayReadonly, options?: {
 		allKeys: boolean;
 	}): PromiseExtended<TKey>;
-	bulkDelete(keys: IndexableTypeArrayReadonly): PromiseExtended<void>;
+	bulkDelete(keys: TKey[]): PromiseExtended<void>;
 }
 export interface Version {
 	stores(schema: {
@@ -702,14 +701,14 @@ export type ObservabilitySet = {
 	// `idb:${dbName}/${tableName}/changedIndexes/${indexName}` - indexes
 	[part: string]: IntervalTree;
 };
-export interface DexieOnTxCommittedEvent {
+export interface DexieOnStorageMutatedEvent {
 	subscribe(fn: (parts: ObservabilitySet) => any): void;
 	unsubscribe(fn: (parts: ObservabilitySet) => any): void;
 	fire(parts: ObservabilitySet): any;
 }
 export interface GlobalDexieEvents extends DexieEventSet {
-	(eventName: "txcommitted", subscriber: (parts: ObservabilitySet) => any): void;
-	txcommitted: DexieOnTxCommittedEvent;
+	(eventName: "storagemutated", subscriber: (parts: ObservabilitySet) => any): void;
+	storagemutated: DexieOnStorageMutatedEvent;
 }
 export type DbSchema = {
 	[tableName: string]: TableSchema;
@@ -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;
@@ -1012,6 +1017,4 @@ export function rangesOverlap(rangeSet1: IntervalTree, rangeSet2: IntervalTree):
  **/
 export default Dexie;
 
-export as namespace Dexie;
-
 export {};

package/dist/dexie.js

@@ -4,7 +4,7 @@
  *
  * By David Fahlander, david.fahlander@gmail.com
  *
- * Version 3.2.0-beta.3, Mon Aug 02 2021
+ * Version 3.2.0, Thu Nov 18 2021
  *
  * http://dexie.org
  *
@@ -15,7 +15,7 @@
     typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
     typeof define === 'function' && define.amd ? define(factory) :
     (global = typeof globalThis !== 'undefined' ? globalThis : global || self, global.Dexie = factory());
-}(this, (function () { 'use strict';
+})(this, (function () { 'use strict';
 
     /*! *****************************************************************************
     Copyright (c) Microsoft Corporation.
@@ -39,10 +39,14 @@
         };
         return __assign.apply(this, arguments);
     };
-    function __spreadArray(to, from) {
-        for (var i = 0, il = from.length, j = to.length; i < il; i++, j++)
-            to[j] = from[i];
-        return to;
+    function __spreadArray(to, from, pack) {
+        if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+            if (ar || !(i in from)) {
+                if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+                ar[i] = from[i];
+            }
+        }
+        return to.concat(ar || Array.prototype.slice.call(from));
     }
 
     var _global = typeof globalThis !== 'undefined' ? globalThis :
@@ -1277,7 +1281,7 @@
         }
     }
 
-    var DEXIE_VERSION = '3.2.0-beta.3';
+    var DEXIE_VERSION = '3.2.0';
     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>.";
@@ -1299,37 +1303,11 @@
             filter2;
     }
 
-    var domDeps;
-    try {
-        domDeps = {
-            indexedDB: _global.indexedDB || _global.mozIndexedDB || _global.webkitIndexedDB || _global.msIndexedDB,
-            IDBKeyRange: _global.IDBKeyRange || _global.webkitIDBKeyRange
-        };
-    }
-    catch (e) {
-        domDeps = { indexedDB: null, IDBKeyRange: null };
-    }
-
-    function safariMultiStoreFix(storeNames) {
-        return storeNames.length === 1 ? storeNames[0] : storeNames;
-    }
-    var getMaxKey = function (IdbKeyRange) {
-        try {
-            IdbKeyRange.only([[]]);
-            getMaxKey = function () { return [[]]; };
-            return [[]];
-        }
-        catch (e) {
-            getMaxKey = function () { return maxString; };
-            return maxString;
-        }
-    };
-
     var AnyRange = {
         type: 3 ,
         lower: -Infinity,
         lowerOpen: false,
-        get upper() { return getMaxKey(domDeps.IDBKeyRange); },
+        upper: [[]],
         upperOpen: false
     };
 
@@ -1797,6 +1775,82 @@
         });
     }
 
+    function cmp(a, b) {
+        try {
+            var ta = type(a);
+            var tb = type(b);
+            if (ta !== tb) {
+                if (ta === 'Array')
+                    return 1;
+                if (tb === 'Array')
+                    return -1;
+                if (ta === 'binary')
+                    return 1;
+                if (tb === 'binary')
+                    return -1;
+                if (ta === 'string')
+                    return 1;
+                if (tb === 'string')
+                    return -1;
+                if (ta === 'Date')
+                    return 1;
+                if (tb !== 'Date')
+                    return NaN;
+                return -1;
+            }
+            switch (ta) {
+                case 'number':
+                case 'Date':
+                case 'string':
+                    return a > b ? 1 : a < b ? -1 : 0;
+                case 'binary': {
+                    return compareUint8Arrays(getUint8Array(a), getUint8Array(b));
+                }
+                case 'Array':
+                    return compareArrays(a, b);
+            }
+        }
+        catch (_a) { }
+        return NaN;
+    }
+    function compareArrays(a, b) {
+        var al = a.length;
+        var bl = b.length;
+        var l = al < bl ? al : bl;
+        for (var i = 0; i < l; ++i) {
+            var res = cmp(a[i], b[i]);
+            if (res !== 0)
+                return res;
+        }
+        return al === bl ? 0 : al < bl ? -1 : 1;
+    }
+    function compareUint8Arrays(a, b) {
+        var al = a.length;
+        var bl = b.length;
+        var l = al < bl ? al : bl;
+        for (var i = 0; i < l; ++i) {
+            if (a[i] !== b[i])
+                return a[i] < b[i] ? -1 : 1;
+        }
+        return al === bl ? 0 : al < bl ? -1 : 1;
+    }
+    function type(x) {
+        var t = typeof x;
+        if (t !== 'object')
+            return t;
+        if (ArrayBuffer.isView(x))
+            return 'binary';
+        var tsTag = toStringTag(x);
+        return tsTag === 'ArrayBuffer' ? 'binary' : tsTag;
+    }
+    function getUint8Array(a) {
+        if (a instanceof Uint8Array)
+            return a;
+        if (ArrayBuffer.isView(a))
+            return new Uint8Array(a.buffer, a.byteOffset, a.byteLength);
+        return new Uint8Array(a);
+    }
+
     var Collection =  (function () {
         function Collection() {
         }
@@ -2080,7 +2134,6 @@
                 var coreTable = ctx.table.core;
                 var _a = coreTable.schema.primaryKey, outbound = _a.outbound, extractKey = _a.extractKey;
                 var limit = _this.db._options.modifyChunkSize || 200;
-                var cmp = _this.db.core.cmp;
                 var totalFailures = [];
                 var successCount = 0;
                 var failedKeys = [];
@@ -2612,7 +2665,9 @@
             event.preventDefault();
     }
 
-    var globalEvents = Events(null, "txcommitted");
+    var DEXIE_STORAGE_MUTATED_EVENT_NAME = 'storagemutated';
+    var STORAGE_MUTATED_DOM_EVENT_NAME = 'x-storagemutated-1';
+    var globalEvents = Events(null, DEXIE_STORAGE_MUTATED_EVENT_NAME);
 
     var Transaction =  (function () {
         function Transaction() {
@@ -2680,7 +2735,7 @@
                 _this.active = false;
                 _this._resolve();
                 if ('mutatedParts' in idbtrans) {
-                    globalEvents.txcommitted.fire(idbtrans["mutatedParts"]);
+                    globalEvents.storagemutated.fire(idbtrans["mutatedParts"]);
                 }
             });
             return this;
@@ -2840,6 +2895,21 @@
         };
     }
 
+    function safariMultiStoreFix(storeNames) {
+        return storeNames.length === 1 ? storeNames[0] : storeNames;
+    }
+    var getMaxKey = function (IdbKeyRange) {
+        try {
+            IdbKeyRange.only([[]]);
+            getMaxKey = function () { return [[]]; };
+            return [[]];
+        }
+        catch (e) {
+            getMaxKey = function () { return maxString; };
+            return maxString;
+        }
+    };
+
     function getKeyExtractor(keyPath) {
         if (keyPath == null) {
             return function () { return undefined; };
@@ -2872,8 +2942,7 @@
                 keyPath :
                 "[" + keyPath.join('+') + "]";
     }
-    function createDBCore(db, indexedDB, IdbKeyRange, tmpTrans) {
-        var cmp = indexedDB.cmp.bind(indexedDB);
+    function createDBCore(db, IdbKeyRange, tmpTrans) {
         function extractSchema(db, trans) {
             var tables = arrayify(db.objectStoreNames);
             return {
@@ -3208,7 +3277,6 @@
                     throw new Error("Table '" + name + "' not found");
                 return tableMap[name];
             },
-            cmp: cmp,
             MIN_KEY: -Infinity,
             MAX_KEY: getMaxKey(IdbKeyRange),
             schema: schema
@@ -3222,8 +3290,8 @@
         }, stackImpl);
     }
     function createMiddlewareStacks(middlewares, idbdb, _a, tmpTrans) {
-        var IDBKeyRange = _a.IDBKeyRange, indexedDB = _a.indexedDB;
-        var dbcore = createMiddlewareStack(createDBCore(idbdb, indexedDB, IDBKeyRange, tmpTrans), middlewares.dbcore);
+        var IDBKeyRange = _a.IDBKeyRange; _a.indexedDB;
+        var dbcore = createMiddlewareStack(createDBCore(idbdb, IDBKeyRange, tmpTrans), middlewares.dbcore);
         return {
             dbcore: dbcore
         };
@@ -3449,12 +3517,9 @@
         });
     }
     function deleteRemovedTables(newSchema, idbtrans) {
-        for (var i = 0; i < idbtrans.db.objectStoreNames.length; ++i) {
-            var storeName = idbtrans.db.objectStoreNames[i];
-            if (newSchema[storeName] == null) {
-                idbtrans.db.deleteObjectStore(storeName);
-            }
-        }
+        [].slice.call(idbtrans.db.objectStoreNames).forEach(function (storeName) {
+            return newSchema[storeName] == null && idbtrans.db.deleteObjectStore(storeName);
+        });
     }
     function addIndex(store, idx) {
         store.createIndex(idx.name, idx.keyPath, { unique: idx.unique, multiEntry: idx.multi });
@@ -3631,18 +3696,17 @@
     }
 
     function idbReady() {
-      var isSafari = !navigator.userAgentData && /Safari\//.test(navigator.userAgent) && !/Chrom(e|ium)\//.test(navigator.userAgent);
-      if (!isSafari || !indexedDB.databases) return Promise.resolve();
-      var intervalId;
-      return new Promise(function (resolve) {
-        var tryIdb = function tryIdb() {
-          return indexedDB.databases().finally(resolve);
-        };
-        intervalId = setInterval(tryIdb, 100);
-        tryIdb();
-      }).finally(function () {
-        return clearInterval(intervalId);
-      });
+        var isSafari = !navigator.userAgentData &&
+            /Safari\//.test(navigator.userAgent) &&
+            !/Chrom(e|ium)\//.test(navigator.userAgent);
+        if (!isSafari || !indexedDB.databases)
+            return Promise.resolve();
+        var intervalId;
+        return new Promise(function (resolve) {
+            var tryIdb = function () { return indexedDB.databases().finally(resolve); };
+            intervalId = setInterval(tryIdb, 100);
+            tryIdb();
+        }).finally(function () { return clearInterval(intervalId); });
     }
 
     function dexieOpen(db) {
@@ -3663,7 +3727,7 @@
         }
         var resolveDbReady = state.dbReadyResolve,
         upgradeTransaction = null, wasCreated = false;
-        return DexiePromise.race([openCanceller, idbReady().then(function () { return new DexiePromise(function (resolve, reject) {
+        return DexiePromise.race([openCanceller, (typeof navigator === 'undefined' ? DexiePromise.resolve() : idbReady()).then(function () { return new DexiePromise(function (resolve, reject) {
                 throwIfCancelled();
                 if (!indexedDB)
                     throw new exceptions.MissingAPI();
@@ -3912,6 +3976,11 @@
                                         cursor.continuePrimaryKey(pad(key, down.MAX_KEY, keyTail), primaryKey);
                                     }
                                 },
+                                primaryKey: {
+                                    get: function () {
+                                        return cursor.primaryKey;
+                                    }
+                                },
                                 key: {
                                     get: function () {
                                         var key = cursor.key;
@@ -4017,9 +4086,9 @@
                                 throw new Error("Keys missing");
                             req = req.type === 'add' || req.type === 'put' ? __assign(__assign({}, req), { keys: keys }) : __assign({}, req);
                             if (req.type !== 'delete')
-                                req.values = __spreadArray([], req.values);
+                                req.values = __spreadArray([], req.values, true);
                             if (req.keys)
-                                req.keys = __spreadArray([], req.keys);
+                                req.keys = __spreadArray([], req.keys, true);
                             return getExistingValues(downTable, req, keys).then(function (existingValues) {
                                 var contexts = keys.map(function (key, i) {
                                     var existingValue = existingValues[i];
@@ -4105,24 +4174,6 @@
             : table.getMany({ trans: req.trans, keys: effectiveKeys, cache: "immutable" });
     }
 
-    var _cmp;
-    function cmp(a, b) {
-        if (_cmp)
-            return _cmp(a, b);
-        var indexedDB = domDeps.indexedDB;
-        if (!indexedDB)
-            throw new exceptions.MissingAPI();
-        _cmp = function (a, b) {
-            try {
-                return a == null || b == null ? NaN : indexedDB.cmp(a, b);
-            }
-            catch (_a) {
-                return NaN;
-            }
-        };
-        return _cmp(a, b);
-    }
-
     function getFromTransactionCache(keys, cache, clone) {
         try {
             if (!cache)
@@ -4814,7 +4865,7 @@
     }());
 
     var symbolObservable = typeof Symbol !== "undefined" && "observable" in Symbol
-        ? Symbol["observable"]
+        ? Symbol.observable
         : "@@observable";
     var Observable =  (function () {
         function Observable(subscribe) {
@@ -4863,7 +4914,7 @@
                 },
                 unsubscribe: function () {
                     closed = true;
-                    globalEvents.txcommitted.unsubscribe(mutationListener);
+                    globalEvents.storagemutated.unsubscribe(mutationListener);
                 },
             };
             observer.start && observer.start(subscription);
@@ -4886,7 +4937,7 @@
                 var subscr = {};
                 var ret = execute(subscr);
                 if (!startedListening) {
-                    globalEvents("txcommitted", mutationListener);
+                    globalEvents(DEXIE_STORAGE_MUTATED_EVENT_NAME, mutationListener);
                     startedListening = true;
                 }
                 querying = true;
@@ -4913,6 +4964,17 @@
         });
     }
 
+    var domDeps;
+    try {
+        domDeps = {
+            indexedDB: _global.indexedDB || _global.mozIndexedDB || _global.webkitIndexedDB || _global.msIndexedDB,
+            IDBKeyRange: _global.IDBKeyRange || _global.webkitIDBKeyRange
+        };
+    }
+    catch (e) {
+        domDeps = { indexedDB: null, IDBKeyRange: null };
+    }
+
     var Dexie = Dexie$1;
     props(Dexie, __assign(__assign({}, fullNameExceptions), {
         delete: function (databaseName) {
@@ -4985,7 +5047,7 @@
         },
         derive: derive, extend: extend, props: props, override: override,
         Events: Events, on: globalEvents, liveQuery: liveQuery, extendObservabilitySet: extendObservabilitySet,
-        getByKeyPath: getByKeyPath, setByKeyPath: setByKeyPath, delByKeyPath: delByKeyPath, shallowClone: shallowClone, deepClone: deepClone, getObjectDiff: getObjectDiff, asap: asap$1,
+        getByKeyPath: getByKeyPath, setByKeyPath: setByKeyPath, delByKeyPath: delByKeyPath, shallowClone: shallowClone, deepClone: deepClone, getObjectDiff: getObjectDiff, cmp: cmp, asap: asap$1,
         minKey: minKey,
         addons: [],
         connections: connections,
@@ -4996,38 +5058,46 @@
             .reduce(function (p, c, i) { return p + (c / Math.pow(10, i * 2)); }) }));
     Dexie.maxKey = getMaxKey(Dexie.dependencies.IDBKeyRange);
 
-    function fireLocally(updateParts) {
+    if (typeof dispatchEvent !== 'undefined' && typeof addEventListener !== 'undefined') {
+        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
+                    });
+                }
+                propagatingLocally = true;
+                dispatchEvent(event_1);
+                propagatingLocally = false;
+            }
+        });
+        addEventListener(STORAGE_MUTATED_DOM_EVENT_NAME, function (_a) {
+            var detail = _a.detail;
+            if (!propagatingLocally) {
+                propagateLocally(detail);
+            }
+        });
+    }
+    function propagateLocally(updateParts) {
         var wasMe = propagatingLocally;
         try {
             propagatingLocally = true;
-            globalEvents.txcommitted.fire(updateParts);
+            globalEvents.storagemutated.fire(updateParts);
         }
         finally {
             propagatingLocally = wasMe;
         }
     }
-    var propagateLocally = fireLocally;
     var propagatingLocally = false;
-    var accumulatedParts = {};
-    if (typeof document !== 'undefined' && document.addEventListener) {
-        var fireIfVisible_1 = function () {
-            if (document.visibilityState === "visible") {
-                if (Object.keys(accumulatedParts).length > 0) {
-                    fireLocally(accumulatedParts);
-                }
-                accumulatedParts = {};
-            }
-        };
-        document.addEventListener("visibilitychange", fireIfVisible_1);
-        propagateLocally = function (changedParts) {
-            extendObservabilitySet(accumulatedParts, changedParts);
-            fireIfVisible_1();
-        };
-    }
 
-    if (typeof BroadcastChannel !== "undefined") {
-        var bc_1 = new BroadcastChannel("dexie-txcommitted");
-        globalEvents("txcommitted", function (changedParts) {
+    if (typeof BroadcastChannel !== 'undefined') {
+        var bc_1 = new BroadcastChannel(STORAGE_MUTATED_DOM_EVENT_NAME);
+        globalEvents(DEXIE_STORAGE_MUTATED_EVENT_NAME, function (changedParts) {
             if (!propagatingLocally) {
                 bc_1.postMessage(changedParts);
             }
@@ -5037,20 +5107,20 @@
                 propagateLocally(ev.data);
         };
     }
-    else if (typeof self !== "undefined" && typeof navigator !== "undefined") {
-        globalEvents("txcommitted", function (changedParts) {
+    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("dexie-txcommitted", JSON.stringify({
+                    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 })).forEach(function (client) {
+                    if (typeof self['clients'] === 'object') {
+                        __spreadArray([], self['clients'].matchAll({ includeUncontrolled: true }), true).forEach(function (client) {
                             return client.postMessage({
-                                type: "dexie-txcommitted",
+                                type: STORAGE_MUTATED_DOM_EVENT_NAME,
                                 changedParts: changedParts,
                             });
                         });
@@ -5059,8 +5129,8 @@
             }
             catch (_a) { }
         });
-        addEventListener("storage", function (ev) {
-            if (ev.key === "dexie-txcommitted") {
+        addEventListener('storage', function (ev) {
+            if (ev.key === STORAGE_MUTATED_DOM_EVENT_NAME) {
                 var data = JSON.parse(ev.newValue);
                 if (data)
                     propagateLocally(data.changedParts);
@@ -5073,7 +5143,7 @@
     }
     function propagateMessageLocally(_a) {
         var data = _a.data;
-        if (data && data.type === "dexie-txcommitted") {
+        if (data && data.type === STORAGE_MUTATED_DOM_EVENT_NAME) {
             propagateLocally(data.changedParts);
         }
     }
@@ -5095,5 +5165,5 @@
 
     return Dexie$1;
 
-})));
+}));
 //# sourceMappingURL=dexie.js.map