indexeddbshim 16.1.0 → 17.1.0

package/src/IDBFactory.js

@@ -31,6 +31,7 @@ let fs;
  * @returns {void}
  */
 const setFS = (_fs) => {
+    // eslint-disable-next-line unicorn/no-top-level-assignment-in-function -- Necessary?
     fs = _fs;
 };
 
@@ -93,7 +94,7 @@ function processNextInConnectionQueue (name, origin = getOrigin()) {
  */
 function addRequestToConnectionQueue (req, name, origin = getOrigin(), cb) {
     /* eslint-enable default-param-last -- Keep cb at end */
-    if (!connectionQueue[origin][name]) {
+    if (!Object.hasOwn(connectionQueue[origin], name)) {
         connectionQueue[origin][name] = [];
     }
     connectionQueue[origin][name].push({req, cb});
@@ -139,7 +140,7 @@ function triggerAnyVersionChangeAndBlockedEvents (openConnections, req, oldVersi
                 setTimeout(() => {
                     entry.dispatchEvent(e); // No need to catch errors
                     resolve(undefined);
-                });
+                }, 0);
             });
         });
     }, SyncPromise.resolve(undefined)).then(function () {
@@ -168,7 +169,7 @@ function triggerAnyVersionChangeAndBlockedEvents (openConnections, req, oldVersi
                 } else {
                     resolve(undefined);
                 }
-            });
+            }, 0);
         });
     });
 }
@@ -229,7 +230,7 @@ function getLatestCachedWebSQLDB (name) {
 function cleanupDatabaseResources (__openDatabase, name, escapedDatabaseName, databaseDeleted, dbError) {
     const useMemoryDatabase = typeof CFG.memoryDatabase === 'string';
     if (useMemoryDatabase) {
-        const latestSQLiteDBCached = websqlDBCache[name] ? getLatestCachedWebSQLDB(name) : null;
+        const latestSQLiteDBCached = Object.hasOwn(websqlDBCache, name) ? getLatestCachedWebSQLDB(name) : null;
         if (!latestSQLiteDBCached) {
             console.warn('Could not find a memory database instance to delete.');
             databaseDeleted();
@@ -334,6 +335,7 @@ function createSysDB (__openDatabase, success, failure) {
     if (sysdb) {
         success();
     } else {
+        // eslint-disable-next-line unicorn/no-top-level-assignment-in-function -- Necessary?
         sysdb = __openDatabase(
             typeof CFG.memoryDatabase === 'string'
                 ? CFG.memoryDatabase
@@ -367,6 +369,7 @@ function createSysDB (__openDatabase, success, failure) {
 /**
  * IDBFactory Class.
  * @see https://w3c.github.io/IndexedDB/#idl-def-IDBFactory
+ * @throws {TypeError}
  * @class
  */
 function IDBFactory () {
@@ -438,6 +441,7 @@ IDBFactory.prototype.open = function (name /* , version */) {
     let calledDbCreateError = false;
 
     if (CFG.autoName && name === '') {
+        // eslint-disable-next-line unicorn/no-top-level-assignment-in-function -- Necessary?
         name = 'autoNamedDatabase_' + nameCounter++;
     }
     name = String(name); // cast to a string
@@ -494,7 +498,7 @@ IDBFactory.prototype.open = function (name /* , version */) {
                 req.__done = true;
             }
             const connection = IDBDatabase.__createInstance(db, name, oldVersion, version, data);
-            if (!me.__connections[name]) {
+            if (!Object.hasOwn(me.__connections, name)) {
                 me.__connections[name] = [];
             }
             me.__connections[name].push(connection);
@@ -589,7 +593,7 @@ IDBFactory.prototype.open = function (name /* , version */) {
                                     req.__result
                                 ).__versionTransaction = null;
                                 sysdbFinishedCb(systx, false, function () {
-                                    req.transaction.__transFinishedCb(false, function () {
+                                    req.transaction.__callTransFinishedCb(false, function () {
                                         ev.complete();
                                         req.__transaction = null;
                                     });
@@ -602,7 +606,7 @@ IDBFactory.prototype.open = function (name /* , version */) {
                                 connection.__upgradeTransaction = null;
                                 // We ensure any cache is deleted before any request error events fire and try to reopen
                                 if (useDatabaseCache) {
-                                    if (name in websqlDBCache) {
+                                    if (Object.hasOwn(websqlDBCache, name)) {
                                         delete websqlDBCache[name][version];
                                     }
                                 }
@@ -633,7 +637,7 @@ IDBFactory.prototype.open = function (name /* , version */) {
                                         dbCreateError(err);
                                         return false;
                                     });
-                                });
+                                }, 0);
                             };
 
                             // eslint-disable-next-line camelcase -- Clear API
@@ -712,7 +716,14 @@ IDBFactory.prototype.open = function (name /* , version */) {
     function openDB (oldVersion) {
         /** @type {DatabaseFull} */
         let db;
-        if ((useMemoryDatabase || useDatabaseCache) && name in websqlDBCache && websqlDBCache[name][version]) {
+        if (version === undefined) {
+            // Resolve before use as a cache key below, or a `open(name)` call
+            //  (no explicit version) would cache/look up under `undefined`
+            //  instead of the actual version, causing a second, separate
+            //  connection to be opened for the same database on reopen.
+            version = oldVersion || 1;
+        }
+        if ((useMemoryDatabase || useDatabaseCache) && Object.hasOwn(websqlDBCache, name) && Object.hasOwn(websqlDBCache[name], version)) {
             db = websqlDBCache[name][version];
         } else {
             db = me.__openDatabase(
@@ -722,22 +733,19 @@ IDBFactory.prototype.open = function (name /* , version */) {
                 CFG.DEFAULT_DB_SIZE
             );
             if (useDatabaseCache) {
-                if (!(name in websqlDBCache)) {
+                if (!(Object.hasOwn(websqlDBCache, name))) {
                     websqlDBCache[name] = {};
                 }
                 websqlDBCache[name][version] = db;
             }
         }
 
-        if (version === undefined) {
-            version = oldVersion || 1;
-        }
         if (oldVersion > version) {
             const err = createDOMException('VersionError', 'An attempt was made to open a database using a lower version than the existing version.', version);
             if (useDatabaseCache) {
                 setTimeout(() => {
                     dbCreateError(err);
-                });
+                }, 0);
             } else {
                 dbCreateError(err);
             }
@@ -764,7 +772,7 @@ IDBFactory.prototype.open = function (name /* , version */) {
     addRequestToConnectionQueue(req, name, /* origin */ undefined, function () {
         let latestCachedVersion;
         if (useDatabaseCache) {
-            if (!(name in websqlDBCache)) {
+            if (!Object.hasOwn(websqlDBCache, name)) {
                 websqlDBCache[name] = {};
             }
             latestCachedVersion = getLatestCachedWebSQLVersion(name);
@@ -884,7 +892,7 @@ IDBFactory.prototype.deleteDatabase = function (name) {
             /** @type {DatabaseDeleted} */
             function databaseDeleted () {
                 sysdbFinishedCbDelete(false, function () {
-                    if (useDatabaseCache && name in websqlDBCache) {
+                    if (useDatabaseCache && Object.hasOwn(websqlDBCache, name)) {
                         delete websqlDBCache[name]; // New calls will treat as though never existed
                     }
                     delete me.__connections[name];
@@ -901,7 +909,7 @@ IDBFactory.prototype.deleteDatabase = function (name) {
                     ({version} = data.rows.item(0));
 
                     const openConnections = me.__connections[name] || [];
-                    triggerAnyVersionChangeAndBlockedEvents(openConnections, req, version, null).then(function () { // eslint-disable-line promise/catch-or-return -- Sync promise
+                    triggerAnyVersionChangeAndBlockedEvents(openConnections, req, version, null).then(function () {
                         // Since we need two databases which can't be in a single transaction, we
                         //  do this deleting from `dbVersions` first since the `__sys__` deleting
                         //  only impacts file memory whereas this one is critical for avoiding it
@@ -930,7 +938,7 @@ IDBFactory.prototype.deleteDatabase = function (name) {
                         });
                         return undefined;
                     // @ts-expect-error It's ok
-                    }, dbError);
+                    }).catch(dbError);
                     return undefined;
                 }, dbError);
             });
@@ -1017,7 +1025,7 @@ IDBFactory.prototype.databases = function () {
 * @todo forceClose: Test
 * This is provided to facilitate unit-testing of the
 *  closing of a database connection with a forced flag:
-* <http://w3c.github.io/IndexedDB/#steps-for-closing-a-database-connection>
+* <https://w3c.github.io/IndexedDB/#steps-for-closing-a-database-connection>
 * @param {string} dbName
 * @param {Integer} connIdx
 * @param {string} msg
@@ -1041,12 +1049,13 @@ IDBFactory.prototype.__forceClose = function (dbName, connIdx, msg) {
                 forceClose(connection);
             });
         });
-    } else if (!me.__connections[dbName]) {
+    } else if (!Object.hasOwn(me.__connections, dbName)) {
         console.log('No database connections with that name to force close');
     } else if (util.isNullish(connIdx)) {
         me.__connections[dbName].forEach((conn) => {
             forceClose(conn);
         });
+    // eslint-disable-next-line unicorn/prefer-number-is-safe-integer -- Ok
     } else if (!Number.isInteger(connIdx) || connIdx < 0 || connIdx > me.__connections[dbName].length - 1) {
         throw new TypeError(
             'If providing an argument, __forceClose must be called with a ' +
@@ -1068,9 +1077,11 @@ IDBFactory.prototype.__setConnectionQueueOrigin = function (origin = getOrigin()
 
 IDBFactory.prototype[Symbol.toStringTag] = 'IDBFactoryPrototype';
 
+/* eslint-disable unicorn/no-top-level-side-effects -- Would be good */
 Object.defineProperty(IDBFactory, 'prototype', {
     writable: false
 });
+/* eslint-enable unicorn/no-top-level-side-effects -- Would be good */
 
 const shimIndexedDB = IDBFactory.__createInstance();
 export {IDBFactory, cmp, shimIndexedDB, setFS};

package/src/IDBIndex.js

@@ -31,7 +31,8 @@ const readonlyProperties = ['objectStore', 'keyPath', 'multiEntry', 'unique'];
 
 /**
  * IDB Index.
- * @see http://www.w3.org/TR/IndexedDB/#idl-def-IDBIndex
+ * @see https://www.w3.org/TR/IndexedDB/#idl-def-IDBIndex
+ * @throws {TypeError}
  * @class
  */
 function IDBIndex () {
@@ -85,83 +86,85 @@ IDBIndex.__createInstance = function (store, indexProperties) {
         me.__unique = Boolean(optionalParams && optionalParams.unique);
         me.__deleted = Boolean(indexProperties.__deleted);
         me.__objectStore.__cursors = indexProperties.cursors || [];
-        Object.defineProperty(me, '__currentName', {
-            /**
-             * @this {IDBIndexFull}
-             * @returns {string}
-             */
-            get () {
-                return '__pendingName' in me
-                    ? /** @type {string} */ (me.__pendingName)
-                    : me.name;
-            }
-        });
-        Object.defineProperty(me, 'name', {
-            enumerable: false,
-            configurable: false,
-            /**
-             * @this {IDBIndexFull}
-             * @returns {string}
-             */
-            get () {
-                return this.__name;
-            },
-            /**
-             * @param {string} newName
-             * @this {IDBIndexFull}
-             * @returns {void}
-             */
-            set (newName) {
-                const me = this;
-                newName = util.convertToDOMString(newName);
-                const oldName = me.name;
-                IDBTransaction.__assertVersionChange(me.objectStore.transaction);
-                IDBTransaction.__assertActive(me.objectStore.transaction);
-                IDBIndexAlias.__invalidStateIfDeleted(me);
-                IDBObjectStore.__invalidStateIfDeleted(me);
-                if (newName === oldName) {
-                    return;
-                }
-
-                if (me.objectStore.__indexes[newName] && !me.objectStore.__indexes[newName].__deleted &&
-                    !me.objectStore.__indexes[newName].__pendingDelete) {
-                    throw createDOMException('ConstraintError', 'Index "' + newName + '" already exists on ' + me.objectStore.__currentName);
+        Object.defineProperties(me, {
+            __currentName: {
+                /**
+                 * @this {IDBIndexFull}
+                 * @returns {string}
+                 */
+                get () {
+                    return '__pendingName' in me
+                        ? /** @type {string} */ (me.__pendingName)
+                        : me.name;
                 }
+            },
+            name: {
+                enumerable: false,
+                configurable: false,
+                /**
+                 * @this {IDBIndexFull}
+                 * @returns {string}
+                 */
+                get () {
+                    return this.__name;
+                },
+                /**
+                 * @param {string} newName
+                 * @this {IDBIndexFull}
+                 * @returns {void}
+                 */
+                set (newName) {
+                    const me = this;
+                    newName = util.convertToDOMString(newName);
+                    const oldName = me.name;
+                    IDBTransaction.__assertVersionChange(me.objectStore.transaction);
+                    IDBTransaction.__assertActive(me.objectStore.transaction);
+                    IDBIndexAlias.__invalidStateIfDeleted(me);
+                    IDBObjectStore.__invalidStateIfDeleted(me);
+                    if (newName === oldName) {
+                        return;
+                    }
 
-                me.__name = newName;
-
-                const {objectStore} = me;
-                delete objectStore.__indexes[oldName];
-                objectStore.__indexes[newName] = me;
-                objectStore.indexNames.splice(objectStore.indexNames.indexOf(oldName), 1, newName);
-
-                const storeHandle = /** @type {import('./IDBTransaction.js').IDBTransactionFull} */ (
-                    objectStore.transaction
-                ).__storeHandles[objectStore.name];
-                const oldIndexHandle = storeHandle.__indexHandles[oldName];
-                oldIndexHandle.__name = newName; // Fix old references
-                storeHandle.__indexHandles[newName] = oldIndexHandle; // Ensure new reference accessible
-                me.__pendingName = oldName;
-
-                const colInfoToPreserveArr = [
-                    ['key', 'BLOB ' + (objectStore.autoIncrement ? 'UNIQUE, inc INTEGER PRIMARY KEY AUTOINCREMENT' : 'PRIMARY KEY')],
-                    ['value', 'BLOB']
-                ].concat(
-                    // @ts-expect-error Has numeric indexes instead of iterator
-                    [...objectStore.indexNames]
-                        .filter((indexName) => indexName !== newName)
-                        .map((indexName) => [util.escapeIndexNameForSQL(indexName), 'BLOB'])
-                );
-
-                me.__renameIndex(
-                    objectStore, oldName, newName, colInfoToPreserveArr,
-                    function (tx, success) {
-                        IDBIndexAlias.__updateIndexList(store, tx, function (store) {
-                            delete storeHandle.__pendingName;
-                            success(store);
-                        });
+                    if (Object.hasOwn(me.objectStore.__indexes, newName) && !me.objectStore.__indexes[newName].__deleted &&
+                        !me.objectStore.__indexes[newName].__pendingDelete) {
+                        throw createDOMException('ConstraintError', 'Index "' + newName + '" already exists on ' + me.objectStore.__currentName);
                     }
-                );
+
+                    me.__name = newName;
+
+                    const {objectStore} = me;
+                    delete objectStore.__indexes[oldName];
+                    objectStore.__indexes[newName] = me;
+                    objectStore.indexNames.splice(objectStore.indexNames.indexOf(oldName), 1, newName);
+
+                    const storeHandle = /** @type {import('./IDBTransaction.js').IDBTransactionFull} */ (
+                        objectStore.transaction
+                    ).__storeHandles[objectStore.name];
+                    const oldIndexHandle = storeHandle.__indexHandles[oldName];
+                    oldIndexHandle.__name = newName; // Fix old references
+                    storeHandle.__indexHandles[newName] = oldIndexHandle; // Ensure new reference accessible
+                    me.__pendingName = oldName;
+
+                    const colInfoToPreserveArr = [
+                        ['key', 'BLOB ' + (objectStore.autoIncrement ? 'UNIQUE, inc INTEGER PRIMARY KEY AUTOINCREMENT' : 'PRIMARY KEY')],
+                        ['value', 'BLOB']
+                    ].concat(
+                        // @ts-expect-error Has numeric indexes instead of iterator
+                        [...objectStore.indexNames]
+                            .filter((indexName) => indexName !== newName)
+                            .map((indexName) => [util.escapeIndexNameForSQL(indexName), 'BLOB'])
+                    );
+
+                    me.__renameIndex(
+                        objectStore, oldName, newName, colInfoToPreserveArr,
+                        function (tx, success) {
+                            IDBIndexAlias.__updateIndexList(store, tx, function (store) {
+                                delete storeHandle.__pendingName;
+                                success(store);
+                            });
+                        }
+                    );
+                }
             }
         });
     }
@@ -288,7 +291,7 @@ IDBIndex.__createIndex = function (store, index) {
                                     Key.encode(indexKey.value, index.multiEntry)
                                 );
                                 if (index.unique) {
-                                    if (indexValues[indexKeyStr]) {
+                                    if (Object.hasOwn(indexValues, indexKeyStr)) {
                                         indexValues = {};
                                         failure(createDOMException(
                                             'ConstraintError',
@@ -634,7 +637,7 @@ IDBIndex.prototype.__renameIndex = function (store, oldName, newName, colInfoToP
     const listColInfoToPreserve = (colInfoToPreserve.length ? (colInfoToPreserve.join(', ') + ', ') : '');
     const listColsToPreserve = (colNamesToPreserve.length ? (colNamesToPreserve.join(', ') + ', ') : '');
 
-    // We could adapt the approach at http://stackoverflow.com/a/8430746/271577
+    // We could adapt the approach at https://stackoverflow.com/a/8430746/271577
     //    to make the approach reusable without passing column names, but it is a bit fragile
     /** @type {import('./IDBTransaction.js').IDBTransactionFull} */ (
         store.transaction
@@ -730,8 +733,7 @@ IDBIndex.prototype.__renameIndex = function (store, oldName, newName, colInfoToP
                                 );
                             })
                         );
-                        SyncPromise.all(indexCreations).then(
-                            finish,
+                        SyncPromise.all(indexCreations).then(finish).catch(
                             /** @type {(reason: any) => PromiseLike<never>} */
                             (error)
                         ).catch((err) => {
@@ -749,6 +751,7 @@ IDBIndex.prototype.__renameIndex = function (store, oldName, newName, colInfoToP
  * @typedef {any} AnyValue
  */
 
+/* eslint-disable unicorn/no-top-level-side-effects -- Would be good */
 Object.defineProperty(IDBIndex, Symbol.hasInstance, {
     /**
      * @param {AnyValue} obj
@@ -769,6 +772,7 @@ IDBIndex.prototype[Symbol.toStringTag] = 'IDBIndexPrototype';
 Object.defineProperty(IDBIndex, 'prototype', {
     writable: false
 });
+/* eslint-enable unicorn/no-top-level-side-effects -- Would be good */
 
 /**
  * @param {number|null} count

package/src/IDBKeyRange.js

@@ -14,7 +14,7 @@ const readonlyProperties = /** @type {const} */ (['lower', 'upper', 'lowerOpen',
 
 /**
  * The IndexedDB KeyRange object.
- * @see http://dvcs.w3.org/hg/IndexedDB/raw-file/tip/Overview.html#dfn-key-range
+ * @see https://dvcs.w3.org/hg/IndexedDB/raw-file/tip/Overview.html#dfn-key-range
  * @throws {TypeError}
  * @class
  */
@@ -35,6 +35,7 @@ const IDBKeyRangeAlias = IDBKeyRange;
 IDBKeyRange.__createInstance = function (lower, upper, lowerOpen, upperOpen) {
     /**
      * @class
+     * @throws {DOMException|Error}
      */
     function IDBKeyRange () {
         this[Symbol.toStringTag] = 'IDBKeyRange';
@@ -136,6 +137,7 @@ IDBKeyRange.bound = function (lower, upper /* , lowerOpen, upperOpen */) {
 };
 IDBKeyRange.prototype[Symbol.toStringTag] = 'IDBKeyRangePrototype';
 
+/* eslint-disable unicorn/no-top-level-side-effects -- Would be good */
 readonlyProperties.forEach((prop) => {
     Object.defineProperty(IDBKeyRange.prototype, '__' + prop, {
         enumerable: false,
@@ -163,19 +165,22 @@ readonlyProperties.forEach((prop) => {
     Object.defineProperty(IDBKeyRange.prototype, prop, desc);
 });
 
-Object.defineProperty(IDBKeyRange, Symbol.hasInstance, {
-    value:
-        /**
-         * @param {object} obj
-         * @returns {boolean}
-         */
-        (obj) => util.isObj(obj) && 'upper' in obj && 'lowerOpen' in obj &&
-            typeof obj.lowerOpen === 'boolean'
+Object.defineProperties(IDBKeyRange, {
+    [Symbol.hasInstance]: {
+        value:
+            /**
+             * @param {object} obj
+             * @returns {boolean}
+             */
+            (obj) => util.isObj(obj) && 'upper' in obj && 'lowerOpen' in obj &&
+                typeof obj.lowerOpen === 'boolean'
+    },
+    prototype: {
+        writable: false
+    }
 });
 
-Object.defineProperty(IDBKeyRange, 'prototype', {
-    writable: false
-});
+/* eslint-enable unicorn/no-top-level-side-effects -- Would be good */
 
 /**
  * @param {IDBKeyRangeFull|undefined} range
@@ -189,30 +194,32 @@ Object.defineProperty(IDBKeyRange, 'prototype', {
 function setSQLForKeyRange (
     range, quotedKeyColumnName, sql, sqlValues, addAnd, checkCached
 ) {
-    if (range && (range.lower !== undefined || range.upper !== undefined)) {
-        if (addAnd) { sql.push('AND'); }
-        let encodedLowerKey, encodedUpperKey;
-        const hasLower = range.lower !== undefined;
-        const hasUpper = range.upper !== undefined;
-        if (hasLower) {
-            encodedLowerKey = checkCached ? range.__lowerCached : Key.encode(range.lower);
-        }
-        if (hasUpper) {
-            encodedUpperKey = checkCached ? range.__upperCached : Key.encode(range.upper);
-        }
-        if (hasLower) {
-            sqlValues.push(util.escapeSQLiteStatement(/** @type {string} */ (encodedLowerKey)));
-            if (hasUpper && encodedLowerKey === encodedUpperKey && !range.lowerOpen && !range.upperOpen) {
-                sql.push(quotedKeyColumnName, '=', '?');
-                return;
-            }
-            sql.push(quotedKeyColumnName, (range.lowerOpen ? '>' : '>='), '?');
-        }
-        if (hasLower && hasUpper) { sql.push('AND'); }
-        if (hasUpper) {
-            sql.push(quotedKeyColumnName, (range.upperOpen ? '<' : '<='), '?');
-            sqlValues.push(util.escapeSQLiteStatement(/** @type {string} */ (encodedUpperKey)));
+    if (!(range && (range.lower !== undefined || range.upper !== undefined))) {
+        return;
+    }
+
+    if (addAnd) { sql.push('AND'); }
+    let encodedLowerKey, encodedUpperKey;
+    const hasLower = range.lower !== undefined;
+    const hasUpper = range.upper !== undefined;
+    if (hasLower) {
+        encodedLowerKey = checkCached ? range.__lowerCached : Key.encode(range.lower);
+    }
+    if (hasUpper) {
+        encodedUpperKey = checkCached ? range.__upperCached : Key.encode(range.upper);
+    }
+    if (hasLower) {
+        sqlValues.push(util.escapeSQLiteStatement(/** @type {string} */ (encodedLowerKey)));
+        if (hasUpper && encodedLowerKey === encodedUpperKey && !range.lowerOpen && !range.upperOpen) {
+            sql.push(quotedKeyColumnName, '=', '?');
+            return;
         }
+        sql.push(quotedKeyColumnName, (range.lowerOpen ? '>' : '>='), '?');
+    }
+    if (hasLower && hasUpper) { sql.push('AND'); }
+    if (hasUpper) {
+        sql.push(quotedKeyColumnName, (range.upperOpen ? '<' : '<='), '?');
+        sqlValues.push(util.escapeSQLiteStatement(/** @type {string} */ (encodedUpperKey)));
     }
 }