indexeddbshim 17.2.1 → 17.3.0

package/src/IDBIndex.js

@@ -1,6 +1,6 @@
 import SyncPromise from 'sync-promise-expanded';
 import {createDOMException} from './DOMException.js';
-import {IDBCursor, IDBCursorWithValue} from './IDBCursor.js';
+import {IDBCursor, IDBCursorWithValue, parseGetAllArgs, parseGetAllRecordsArgs, collectAll} from './IDBCursor.js';
 import * as util from './util.js';
 import * as Key from './Key.js';
 import {setSQLForKeyRange, IDBKeyRange, convertValueToKeyRange} from './IDBKeyRange.js';
@@ -15,6 +15,14 @@ const readonlyProperties = ['objectStore', 'keyPath', 'multiEntry', 'unique'];
  * @typedef {number} Integer
  */
 
+/**
+ * @typedef {import('websql-configurable/lib/websql/WebSQLTransaction.js').default} WebSQLTransaction
+ */
+
+/**
+ * @typedef {import('websql-configurable/lib/websql/WebSQLTransaction.js').SqlErrorCallback} SqlErrorCallback
+ */
+
 /**
  * @typedef {{
  *   columnName: string,
@@ -58,7 +66,23 @@ const IDBIndexAlias = IDBIndex;
  *   __unique: boolean,
  *   __objectStore: import('./IDBObjectStore.js').IDBObjectStoreFull,
  *   __keyPath: import('./Key.js').KeyPath,
- *   __recreated?: boolean
+ *   __recreated?: boolean,
+ *   __fetchIndexData: (
+ *     range: any,
+ *     opType: "value"|"key"|"count",
+ *     nullDisallowed: boolean,
+ *     count?: number
+ *   ) => import('./IDBRequest.js').IDBRequestFull,
+ *   __renameIndex: (
+ *     store: import('./IDBObjectStore.js').IDBObjectStoreFull,
+ *     oldName: string,
+ *     newName: string,
+ *     colInfoToPreserveArr?: string[][],
+ *     cb?: null|((
+ *       tx: WebSQLTransaction,
+ *       success: ((store: IDBObjectStore) => void)
+ *     ) => void)
+ *   ) => void
  * }} IDBIndexFull
  */
 
@@ -149,7 +173,7 @@ IDBIndex.__createInstance = function (store, indexProperties) {
                         ['key', 'BLOB ' + (objectStore.autoIncrement ? 'UNIQUE, inc INTEGER PRIMARY KEY AUTOINCREMENT' : 'PRIMARY KEY')],
                         ['value', 'BLOB']
                     ].concat(
-                        // @ts-expect-error Has numeric indexes instead of iterator
+                        // @ts-ignore Has numeric indexes instead of iterator; needed under some TS versions
                         [...objectStore.indexNames]
                             .filter((indexName) => indexName !== newName)
                             .map((indexName) => [util.escapeIndexNameForSQL(indexName), 'BLOB'])
@@ -252,8 +276,8 @@ IDBIndex.__createIndex = function (store, index) {
         let indexValues = {};
 
         /**
-         * @param {SQLTransaction} tx
-         * @param {SQLError} err
+         * @param {WebSQLTransaction} tx
+         * @param {(Error & {code?: number})} err
          * @returns {void}
          */
         function error (tx, err) {
@@ -261,7 +285,7 @@ IDBIndex.__createIndex = function (store, index) {
         }
 
         /**
-         * @param {SQLTransaction} tx
+         * @param {WebSQLTransaction} tx
          * @returns {void}
          */
         function applyIndex (tx) {
@@ -279,7 +303,8 @@ IDBIndex.__createIndex = function (store, index) {
                     function addIndexEntry (i) {
                         if (i < data.rows.length) {
                             try {
-                                const value = Sca.decode(util.unescapeSQLiteResponse(data.rows.item(i).value));
+                                const row = /** @type {{key: string, value: string}} */ (data.rows.item(i));
+                                const value = Sca.decode(util.unescapeSQLiteResponse(row.value));
                                 const indexKey = Key.extractKeyValueDecodedFromValueUsingKeyPath(value, index.keyPath, index.multiEntry); // Todo: Do we need this stricter error checking?
                                 if (
                                     ('invalid' in indexKey && indexKey.invalid) ||
@@ -305,11 +330,11 @@ IDBIndex.__createIndex = function (store, index) {
                                 tx.executeSql(
                                     'UPDATE ' + util.escapeStoreNameForSQL(storeName) + ' SET ' +
                                         util.escapeIndexNameForSQL(indexName) + ' = ? WHERE "key" = ?',
-                                    [util.escapeSQLiteStatement(indexKeyStr), data.rows.item(i).key],
+                                    [util.escapeSQLiteStatement(indexKeyStr), row.key],
                                     function () {
                                         addIndexEntry(i + 1);
                                     },
-                                    /** @type {SQLStatementErrorCallback} */ (error)
+                                    /** @type {SqlErrorCallback} */ (error)
                                 );
                             } catch (err) {
                                 // Not a valid value to insert into index, so just continue
@@ -328,15 +353,15 @@ IDBIndex.__createIndex = function (store, index) {
                             success(store);
                         }
                     }
-                }, /** @type {SQLStatementErrorCallback} */ (error));
-            }, /** @type {SQLStatementErrorCallback} */ (error));
+                }, /** @type {SqlErrorCallback} */ (error));
+            }, /** @type {SqlErrorCallback} */ (error));
         }
 
         const escapedStoreNameSQL = util.escapeStoreNameForSQL(storeName);
         const escapedIndexNameSQL = util.escapeIndexNameForSQL(index.name);
 
         /**
-         * @param {SQLTransaction} tx
+         * @param {WebSQLTransaction} tx
          * @returns {void}
          */
         function addIndexSQL (tx) {
@@ -354,7 +379,7 @@ IDBIndex.__createIndex = function (store, index) {
                     '" ON ' + escapedStoreNameSQL + '(' + escapedIndexNameSQL + ')',
                 [],
                 applyIndex,
-                /** @type {SQLStatementErrorCallback} */ (error)
+                /** @type {SqlErrorCallback} */ (error)
             );
         }
 
@@ -367,7 +392,7 @@ IDBIndex.__createIndex = function (store, index) {
             const sql = ['ALTER TABLE', escapedStoreNameSQL, 'ADD', escapedIndexNameSQL, 'BLOB'].join(' ');
             if (CFG.DEBUG) { console.log(sql); }
             tx.executeSql(
-                sql, [], addIndexSQL, /** @type {SQLStatementErrorCallback} */ (error)
+                sql, [], addIndexSQL, /** @type {SqlErrorCallback} */ (error)
             );
         }
     });
@@ -395,8 +420,8 @@ IDBIndex.__deleteIndex = function (store, index) {
         transaction
     ).__addNonRequestToTransactionQueue(function deleteIndex (tx, args, success, failure) {
         /**
-         * @param {SQLTransaction} tx
-         * @param {SQLError} err
+         * @param {WebSQLTransaction} tx
+         * @param {(Error & {code?: number})} err
          * @returns {void}
          */
         function error (tx, err) {
@@ -417,7 +442,7 @@ IDBIndex.__deleteIndex = function (store, index) {
                     delete indexHandle.__pendingDelete;
                 }
                 success(store);
-            }, /** @type {SQLStatementErrorCallback} */ (error));
+            }, /** @type {SqlErrorCallback} */ (error));
         }
 
         if (!CFG.useSQLiteIndexes) {
@@ -432,7 +457,7 @@ IDBIndex.__deleteIndex = function (store, index) {
                 ),
             [],
             finishDeleteIndex,
-            /** @type {SQLStatementErrorCallback} */ (error)
+            /** @type {SqlErrorCallback} */ (error)
         );
     });
 };
@@ -444,12 +469,9 @@ IDBIndex.__deleteIndex = function (store, index) {
 /**
  * Updates index list for the given object store.
  * @param {import('./IDBObjectStore.js').IDBObjectStoreFull} store
- * @param {SQLTransaction} tx
+ * @param {WebSQLTransaction} tx
  * @param {(store: IDBObjectStore) => void} success
- * @param {(
- *   tx: SQLTransaction,
- *   err: SQLError
- * ) => boolean} [failure]
+ * @param {SqlErrorCallback} [failure]
  * @returns {void}
  */
 IDBIndex.__updateIndexList = function (store, tx, success, failure) {
@@ -471,7 +493,7 @@ IDBIndex.__updateIndexList = function (store, tx, success, failure) {
     if (CFG.DEBUG) { console.log('Updating the index list for ' + store.__currentName, indexList); }
     tx.executeSql('UPDATE __sys__ SET "indexList" = ? WHERE "name" = ?', [JSON.stringify(indexList), util.escapeSQLiteStatement(store.__currentName)], function () {
         success(store);
-    }, /** @type {SQLStatementErrorCallback} */ (failure));
+    }, /** @type {SqlErrorCallback} */ (failure));
 };
 
 /**
@@ -577,20 +599,30 @@ IDBIndex.prototype.getKey = function (query) {
  * @this {IDBIndexFull}
  * @returns {import('./IDBRequest.js').IDBRequestFull}
  */
-IDBIndex.prototype.getAll = function (/* query, count */) {
+IDBIndex.prototype.getAll = function (/* queryOrOptions, count */) {
+    // eslint-disable-next-line prefer-rest-params -- API
+    const {query, count, direction} = parseGetAllArgs(arguments);
+    return collectAll(this, query, count, direction, 'value');
+};
+
+/**
+ * @this {IDBIndexFull}
+ * @returns {import('./IDBRequest.js').IDBRequestFull}
+ */
+IDBIndex.prototype.getAllKeys = function (/* queryOrOptions, count */) {
     // eslint-disable-next-line prefer-rest-params -- API
-    const [query, count] = arguments;
-    return this.__fetchIndexData(query, 'value', false, count);
+    const {query, count, direction} = parseGetAllArgs(arguments);
+    return collectAll(this, query, count, direction, 'key');
 };
 
 /**
  * @this {IDBIndexFull}
  * @returns {import('./IDBRequest.js').IDBRequestFull}
  */
-IDBIndex.prototype.getAllKeys = function (/* query, count */) {
+IDBIndex.prototype.getAllRecords = function (/* options */) {
     // eslint-disable-next-line prefer-rest-params -- API
-    const [query, count] = arguments;
-    return this.__fetchIndexData(query, 'key', false, count);
+    const {query, count, direction} = parseGetAllRecordsArgs(arguments);
+    return collectAll(this, query, count, direction, 'record');
 };
 
 /**
@@ -620,7 +652,7 @@ IDBIndex.prototype.count = function (/* query */) {
  * @param {string} newName
  * @param {string[][]} colInfoToPreserveArr
  * @param {null|((
- *   tx: SQLTransaction,
+ *   tx: WebSQLTransaction,
  *   success: ((store: IDBObjectStore) => void)
  * ) => void)} cb
  * @this {IDBIndexFull}
@@ -643,8 +675,8 @@ IDBIndex.prototype.__renameIndex = function (store, oldName, newName, colInfoToP
         store.transaction
     ).__addNonRequestToTransactionQueue(function renameIndex (tx, args, success, error) {
         /**
-         * @param {SQLTransaction} tx
-         * @param {SQLError} err
+         * @param {WebSQLTransaction} tx
+         * @param {(Error & {code?: number})} err
          * @returns {void}
          */
         function sqlError (tx, err) {
@@ -698,7 +730,7 @@ IDBIndex.prototype.__renameIndex = function (store, oldName, newName, colInfoToP
                                     sql,
                                     [],
                                     resolve,
-                                    /** @type {SQLStatementErrorCallback} */
+                                    /** @type {SqlErrorCallback} */
                                     (function (tx, err) {
                                         reject(err);
                                     })
@@ -720,13 +752,13 @@ IDBIndex.prototype.__renameIndex = function (store, oldName, newName, colInfoToP
                                         if (CFG.DEBUG) { console.log(sql); }
                                         tx.executeSql(
                                             sql, [], resolve,
-                                            /** @type {SQLStatementErrorCallback} */
+                                            /** @type {SqlErrorCallback} */
                                             (function (tx, err) {
                                                 reject(err);
                                             })
                                         );
                                     },
-                                    /** @type {SQLStatementErrorCallback} */
+                                    /** @type {SqlErrorCallback} */
                                     (function (tx, err) {
                                         reject(err);
                                     })
@@ -740,10 +772,10 @@ IDBIndex.prototype.__renameIndex = function (store, oldName, newName, colInfoToP
                             console.log('Index rename error');
                             throw err;
                         });
-                    }, /** @type {SQLStatementErrorCallback} */ (sqlError));
-                }, /** @type {SQLStatementErrorCallback} */ (sqlError));
-            }, /** @type {SQLStatementErrorCallback} */ (sqlError));
-        }, /** @type {SQLStatementErrorCallback} */ (sqlError));
+                    }, /** @type {SqlErrorCallback} */ (sqlError));
+                }, /** @type {SqlErrorCallback} */ (sqlError));
+            }, /** @type {SqlErrorCallback} */ (sqlError));
+        }, /** @type {SqlErrorCallback} */ (sqlError));
     });
 };
 
@@ -766,6 +798,7 @@ Object.defineProperty(IDBIndex, Symbol.hasInstance, {
 
 util.defineReadonlyOuterInterface(IDBIndex.prototype, readonlyProperties);
 util.defineOuterInterface(IDBIndex.prototype, ['name']);
+util.setOperationNames(IDBIndex.prototype);
 
 IDBIndex.prototype[Symbol.toStringTag] = 'IDBIndexPrototype';
 
@@ -784,10 +817,10 @@ Object.defineProperty(IDBIndex, 'prototype', {
  * @param {boolean} multiChecks
  * @param {string[]} sql
  * @param {string[]} sqlValues
- * @param {SQLTransaction} tx
+ * @param {WebSQLTransaction} tx
  * @param {null|undefined} args
  * @param {(result: number|undefined|[]|AnyValue|AnyValue[]) => void} success
- * @param {(tx: SQLTransaction, err: SQLError) => void} error
+ * @param {(tx: WebSQLTransaction, err: (Error & {code?: number})) => void} error
  * @returns {void}
  */
 function executeFetchIndexData (
@@ -835,7 +868,7 @@ function executeFetchIndexData (
             const escapedIndexNameForKeyCol = util.escapeIndexNameForSQLKeyColumn(index.name);
             const encodedKey = Key.encode(range, index.multiEntry);
             for (let i = 0; i < data.rows.length; i++) {
-                const row = data.rows.item(i);
+                const row = /** @type {{key: string, value: string, [k: string]: string}} */ (data.rows.item(i));
                 const rowKey = /** @type {import('./Key.js').ValueTypeArray} */ (
                     Key.decode(row[escapedIndexNameForKeyCol])
                 );
@@ -873,7 +906,7 @@ function executeFetchIndexData (
             }
         } else {
             for (let i = 0; i < data.rows.length; i++) {
-                const record = data.rows.item(i);
+                const record = /** @type {{key: string, value: string}} */ (data.rows.item(i));
                 if (record) {
                     records.push(decode(record));
                 }
@@ -887,7 +920,7 @@ function executeFetchIndexData (
         } else {
             success(unboundedDisallowed ? records[0] : records);
         }
-    }, /** @type {SQLStatementErrorCallback} */ (error));
+    }, /** @type {SqlErrorCallback} */ (error));
 }
 
 /**

package/src/IDBKeyRange.js

@@ -6,9 +6,12 @@ const readonlyProperties = /** @type {const} */ (['lower', 'upper', 'lowerOpen',
 
 /**
  * @typedef {globalThis.IDBKeyRange & {
+ *   __lower: import('./Key.js').Key|undefined,
+ *   __upper: import('./Key.js').Key|undefined,
  *   __lowerCached: string|null|false,
  *   __upperCached: string|null|false,
  *   __lowerOpen: boolean,
+ *   __upperOpen: boolean,
  * }} IDBKeyRangeFull
  */
 
@@ -19,8 +22,6 @@ const readonlyProperties = /** @type {const} */ (['lower', 'upper', 'lowerOpen',
  * @class
  */
 function IDBKeyRange () {
-    this.__lowerOpen = false;
-    this.__upperOpen = false;
     throw new TypeError('Illegal constructor');
 }
 const IDBKeyRangeAlias = IDBKeyRange;
@@ -35,9 +36,11 @@ const IDBKeyRangeAlias = IDBKeyRange;
 IDBKeyRange.__createInstance = function (lower, upper, lowerOpen, upperOpen) {
     /**
      * @class
+     * @this {IDBKeyRangeFull}
      * @throws {DOMException|Error}
      */
     function IDBKeyRange () {
+        // @ts-expect-error Should be ok
         this[Symbol.toStringTag] = 'IDBKeyRange';
         if (lower === undefined && upper === undefined) {
             throw createDOMException('DataError', 'Both arguments to the key range method cannot be undefined');
@@ -138,6 +141,9 @@ IDBKeyRange.bound = function (lower, upper /* , lowerOpen, upperOpen */) {
 IDBKeyRange.prototype[Symbol.toStringTag] = 'IDBKeyRangePrototype';
 
 /* eslint-disable unicorn/no-top-level-side-effects -- Would be good */
+util.setOperationNames(IDBKeyRange.prototype);
+util.setOperationNames(IDBKeyRange);
+
 readonlyProperties.forEach((prop) => {
     Object.defineProperty(IDBKeyRange.prototype, '__' + prop, {
         enumerable: false,