indexeddbshim 17.2.1 → 17.3.0

package/src/IDBObjectStore.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 {setSQLForKeyRange, convertValueToKeyRange} from './IDBKeyRange.js';
 import DOMStringList from './DOMStringList.js';
 import * as util from './util.js';
@@ -16,6 +16,10 @@ const readonlyProperties = ['keyPath', 'indexNames', 'transaction', 'autoIncreme
  * @typedef {number} Integer
  */
 
+/**
+ * @typedef {import('websql-configurable/lib/websql/WebSQLTransaction.js').default} WebSQLTransaction
+ */
+
 /**
  * IndexedDB Object Store.
  * @see https://dvcs.w3.org/hg/IndexedDB/raw-file/tip/Overview.html#idl-def-IDBObjectStore
@@ -31,7 +35,7 @@ const IDBObjectStoreAlias = IDBObjectStore;
  * @typedef {IDBObjectStore & {
  *   name: string,
  *   keyPath: import('./Key.js').KeyPath,
- *   transaction?: import('./IDBTransaction.js').IDBTransactionFull,
+ *   transaction?: import('./IDBTransaction.js').IDBTransactionFull|null,
  *   indexNames: import('./DOMStringList.js').DOMStringListFull,
  *   autoIncrement: boolean,
  *   __autoIncrement: boolean,
@@ -39,7 +43,7 @@ const IDBObjectStoreAlias = IDBObjectStore;
  *   __indexHandles: {[key: string]: import('./IDBIndex.js').IDBIndexFull},
  *   __indexNames: import('./DOMStringList.js').DOMStringListFull,
  *   __oldIndexNames: import('./DOMStringList.js').DOMStringListFull,
- *   __transaction?: import('./IDBTransaction.js').IDBTransactionFull,
+ *   __transaction?: import('./IDBTransaction.js').IDBTransactionFull|null,
  *   __name: string,
  *   __keyPath: import('./Key.js').KeyPath,
  *   __originalName: string,
@@ -53,13 +57,46 @@ const IDBObjectStoreAlias = IDBObjectStore;
  *     import('./IDBCursor.js').IDBCursorWithValueFull
  *   )[],
  *   __idbdb: import('./IDBDatabase.js').IDBDatabaseFull,
+ *   __validateKeyAndValueAndCloneValue: (
+ *     value: import('./Key.js').Value,
+ *     key: import('./Key.js').Key,
+ *     cursorUpdate: boolean
+ *   ) => KeyValueArray,
+ *   __deriveKey: (
+ *     tx: WebSQLTransaction,
+ *     value: import('./Key.js').Value,
+ *     key: import('./Key.js').Key,
+ *     success: (key: import('./Key.js').Key, cn?: Integer) => void,
+ *     failCb: import('./Key.js').SQLFailureCallback
+ *   ) => void,
+ *   __insertData: (
+ *     tx: WebSQLTransaction,
+ *     encoded: string,
+ *     value: import('./Key.js').Value,
+ *     clonedKeyOrCurrentNumber: import('./Key.js').Key|Integer,
+ *     oldCn: Integer|undefined,
+ *     success: (clonedKeyOrCurrentNumber: import('./Key.js').Key|Integer) => void,
+ *     error: (err: Error|DOMException) => void
+ *   ) => SyncPromise,
+ *   __overwrite: (
+ *     tx: WebSQLTransaction,
+ *     key: import('./Key.js').Key,
+ *     cb: (tx: WebSQLTransaction) => void,
+ *     error: (err: (Error & {code?: number})) => void
+ *   ) => void,
+ *   __get: (
+ *     query: import('./Key.js').Value,
+ *     getKey?: boolean,
+ *     getAll?: boolean,
+ *     count?: Integer
+ *   ) => import('./IDBRequest.js').IDBRequestFull,
  * }} IDBObjectStoreFull
  */
 
 /**
  *
  * @param {import('./IDBDatabase.js').IDBObjectStoreProperties} storeProperties
- * @param {import('./IDBTransaction.js').IDBTransactionFull} [transaction]
+ * @param {import('./IDBTransaction.js').IDBTransactionFull|null} [transaction]
  * @returns {IDBObjectStoreFull}
  */
 IDBObjectStore.__createInstance = function (storeProperties, transaction) {
@@ -254,8 +291,8 @@ IDBObjectStore.__createObjectStore = function (db, store) {
 
     transaction.__addNonRequestToTransactionQueue(function createObjectStore (tx, args, success, failure) {
         /**
-         * @param {SQLTransaction} tx
-         * @param {SQLError} [err]
+         * @param {WebSQLTransaction} tx
+         * @param {(Error & {code?: number})} [err]
          * @returns {boolean}
          */
         function error (tx, err) {
@@ -315,20 +352,20 @@ IDBObjectStore.__deleteObjectStore = function (db, store) {
 
     db.objectStoreNames.splice(db.objectStoreNames.indexOf(store.__currentName), 1);
 
-    const storeHandle = db.__versionTransaction.__storeHandles[store.__currentName];
+    const transaction = /** @type {import('./IDBTransaction.js').IDBTransactionFull} */ (
+        db.__versionTransaction
+    );
+    const storeHandle = transaction.__storeHandles[store.__currentName];
     if (storeHandle) {
         storeHandle.__indexNames = DOMStringList.__createInstance();
         storeHandle.__pendingDelete = true;
     }
 
     // Remove the object store from WebSQL
-    const transaction = /** @type {import('./IDBTransaction.js').IDBTransactionFull} */ (
-        db.__versionTransaction
-    );
     transaction.__addNonRequestToTransactionQueue(function deleteObjectStore (tx, args, success, failure) {
         /**
-         * @param {SQLTransaction} tx
-         * @param {SQLError} [err]
+         * @param {WebSQLTransaction} tx
+         * @param {(Error & {code?: number})} [err]
          * @returns {boolean}
          */
         function error (tx, err) {
@@ -386,7 +423,10 @@ IDBObjectStore.prototype.__validateKeyAndValueAndCloneValue = function (value, k
         // Todo Binary: Avoid blobs loading async to ensure cloning (and errors therein)
         //   occurs sync; then can make cloning and this method without callbacks (except where ok
         //   to be async)
-        const clonedValue = Sca.clone(value);
+        const clonedValue = Sca.cloneWithInactiveTransaction(
+            /** @type {import('./IDBTransaction.js').IDBTransactionFull} */ (me.transaction),
+            value
+        );
         key = Key.extractKeyValueDecodedFromValueUsingKeyPath(clonedValue, me.keyPath); // May throw so "rethrow"
         if (key.invalid) {
             throw createDOMException('DataError', 'KeyPath was specified, but key was invalid.');
@@ -417,7 +457,10 @@ IDBObjectStore.prototype.__validateKeyAndValueAndCloneValue = function (value, k
     } else {
         Key.convertValueToKeyRethrowingAndIfInvalid(key);
     }
-    const clonedValue = Sca.clone(value);
+    const clonedValue = Sca.cloneWithInactiveTransaction(
+    /** @type {import('./IDBTransaction.js').IDBTransactionFull} */ (me.transaction),
+        value
+    );
     return [key, clonedValue];
 };
 
@@ -426,7 +469,7 @@ IDBObjectStore.prototype.__validateKeyAndValueAndCloneValue = function (value, k
  *   the object store
  * If the table has auto increment, get the current number (unless it has
  *   a keyPath leading to a valid but non-numeric or < 1 key).
- * @param {SQLTransaction} tx
+ * @param {WebSQLTransaction} tx
  * @param {import('./Key.js').Value} value
  * @param {import('./Key.js').Key} key
  * @param {(key: import('./Key.js').Key, cn?: Integer) => void} success
@@ -477,7 +520,7 @@ IDBObjectStore.prototype.__deriveKey = function (tx, value, key, success, failCb
 
 /**
  *
- * @param {SQLTransaction} tx
+ * @param {WebSQLTransaction} tx
  * @param {string} encoded
  * @param {import('./Key.js').Value} value
  * @param {import('./Key.js').Key|Integer} clonedKeyOrCurrentNumber
@@ -658,6 +701,7 @@ IDBObjectStore.prototype.add = function (value /* , key */) {
         me.transaction
     ).__createRequest(me);
     const [ky, clonedValue] = me.__validateKeyAndValueAndCloneValue(value, key, false);
+    // @ts-ignore -- Private API
     IDBObjectStore.__storingRecordObjectStore(request, me, true, clonedValue, true, ky);
     return request;
 };
@@ -689,16 +733,17 @@ IDBObjectStore.prototype.put = function (value /* , key */) {
         me.transaction
     ).__createRequest(me);
     const [ky, clonedValue] = me.__validateKeyAndValueAndCloneValue(value, key, false);
+    // @ts-ignore -- Private API
     IDBObjectStore.__storingRecordObjectStore(request, me, true, clonedValue, false, ky);
     return request;
 };
 
 /**
  *
- * @param {SQLTransaction} tx
+ * @param {WebSQLTransaction} tx
  * @param {import('./Key.js').Key} key
- * @param {(tx: SQLTransaction) => void} cb
- * @param {(err: SQLError) => void} error
+ * @param {(tx: WebSQLTransaction) => void} cb
+ * @param {(err: (Error & {code?: number})) => void} error
  * @this {IDBObjectStoreFull}
  * @returns {void}
  */
@@ -735,7 +780,7 @@ IDBObjectStore.__storingRecordObjectStore = function (request, store, invalidate
         store.__deriveKey(tx, value, key, function (clonedKeyOrCurrentNumber, oldCn) {
             Sca.encode(value, function (encoded) {
                 /**
-                 * @param {SQLTransaction} tx
+                 * @param {WebSQLTransaction} tx
                  * @returns {void}
                  */
                 function insert (tx) {
@@ -762,20 +807,15 @@ IDBObjectStore.__storingRecordObjectStore = function (request, store, invalidate
  *
  * @param {import('./Key.js').Value} query
  * @param {boolean} [getKey]
- * @param {boolean} [getAll]
- * @param {Integer} [count]
  * @this {IDBObjectStoreFull}
  * @returns {import('./IDBRequest.js').IDBRequestFull}
  */
-IDBObjectStore.prototype.__get = function (query, getKey, getAll, count) {
+IDBObjectStore.prototype.__get = function (query, getKey) {
     const me = this;
-    if (count !== undefined) {
-        count = util.enforceRange(count, 'unsigned long');
-    }
     IDBObjectStore.__invalidStateIfDeleted(me);
     IDBTransaction.__assertActive(me.transaction);
 
-    const range = convertValueToKeyRange(query, !getAll);
+    const range = convertValueToKeyRange(query, true);
 
     const col = getKey ? 'key' : 'value';
     const sql = ['SELECT', util.sqlQuote(col), 'FROM', util.escapeStoreNameForSQL(me.__currentName)];
@@ -785,15 +825,7 @@ IDBObjectStore.prototype.__get = function (query, getKey, getAll, count) {
         sql.push('WHERE');
         setSQLForKeyRange(range, util.sqlQuote('key'), sql, sqlValues);
     }
-    if (!getAll) {
-        count = 1;
-    }
-    if (count) {
-        if (!Number.isFinite(count)) {
-            throw new TypeError('The count parameter must be a finite number');
-        }
-        sql.push('LIMIT', String(count));
-    }
+    sql.push('LIMIT', '1');
     const sqlStr = sql.join(' ');
     return /** @type {import('./IDBTransaction.js').IDBTransactionFull} */ (
         me.transaction
@@ -805,31 +837,12 @@ IDBObjectStore.prototype.__get = function (query, getKey, getAll, count) {
             try {
                 // Opera can't deal with the try-catch here.
                 if (data.rows.length === 0) {
-                    if (getAll) {
-                        success([]);
-                    } else {
-                        success();
-                    }
+                    success();
                     return;
                 }
-                ret = [];
-                if (getKey) {
-                    for (let i = 0; i < data.rows.length; i++) {
-                        // Key.convertValueToKey(data.rows.item(i).key); // Already validated before storage
-                        ret.push(
-                            Key.decode(util.unescapeSQLiteResponse(data.rows.item(i).key), false)
-                        );
-                    }
-                } else {
-                    for (let i = 0; i < data.rows.length; i++) {
-                        ret.push(
-                            Sca.decode(util.unescapeSQLiteResponse(data.rows.item(i).value))
-                        );
-                    }
-                }
-                if (!getAll) {
-                    ret = ret[0];
-                }
+                ret = getKey
+                    ? Key.decode(util.unescapeSQLiteResponse(/** @type {{key: string}} */ (data.rows.item(0)).key), false)
+                    : Sca.decode(util.unescapeSQLiteResponse(/** @type {{value: string}} */ (data.rows.item(0)).value));
             } catch (e) {
                 // If no result is returned, or error occurs when parsing JSON
                 if (CFG.DEBUG) { console.log(e); }
@@ -873,20 +886,30 @@ IDBObjectStore.prototype.getKey = function (query) {
  * @this {IDBObjectStoreFull}
  * @returns {import('./IDBRequest.js').IDBRequestFull}
  */
-IDBObjectStore.prototype.getAll = function (/* query, count */) {
+IDBObjectStore.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 {IDBObjectStoreFull}
+ * @returns {import('./IDBRequest.js').IDBRequestFull}
+ */
+IDBObjectStore.prototype.getAllKeys = function (/* queryOrOptions, count */) {
     // eslint-disable-next-line prefer-rest-params -- API
-    const [query, count] = arguments;
-    return this.__get(query, false, true, count);
+    const {query, count, direction} = parseGetAllArgs(arguments);
+    return collectAll(this, query, count, direction, 'key');
 };
 
 /**
  * @this {IDBObjectStoreFull}
  * @returns {import('./IDBRequest.js').IDBRequestFull}
  */
-IDBObjectStore.prototype.getAllKeys = function (/* query, count */) {
+IDBObjectStore.prototype.getAllRecords = function (/* options */) {
     // eslint-disable-next-line prefer-rest-params -- API
-    const [query, count] = arguments;
-    return this.__get(query, true, true, count);
+    const {query, count, direction} = parseGetAllRecordsArgs(arguments);
+    return collectAll(this, query, count, direction, 'record');
 };
 
 /**
@@ -1128,6 +1151,7 @@ IDBObjectStore.prototype.deleteIndex = function (name) {
 /* eslint-disable unicorn/no-top-level-side-effects -- Would be good */
 util.defineReadonlyOuterInterface(IDBObjectStore.prototype, readonlyProperties);
 util.defineOuterInterface(IDBObjectStore.prototype, ['name']);
+util.setOperationNames(IDBObjectStore.prototype);
 
 IDBObjectStore.prototype[Symbol.toStringTag] = 'IDBObjectStorePrototype';
 

package/src/IDBRecord.js

@@ -0,0 +1,96 @@
+import * as util from './util.js';
+
+const readonlyProperties = /** @type {const} */ (['key', 'primaryKey', 'value']);
+
+/* eslint-disable jsdoc/valid-types -- pratt parser bug */
+/**
+ * @typedef {{
+ *   [Symbol.toStringTag]: 'IDBRecord',
+ *   __key: import('./Key.js').Key,
+ *   __primaryKey: import('./Key.js').Key,
+ *   __value: import('./Key.js').Value,
+ *   key: import('./Key.js').Key,
+ *   primaryKey: import('./Key.js').Key,
+ *   value: import('./Key.js').Value
+ * }} IDBRecordFull
+ */
+/* eslint-enable jsdoc/valid-types -- pratt parser bug */
+
+/**
+ * The record type returned by `IDBObjectStore`/`IDBIndex#getAllRecords()`
+ *   (IndexedDB 3.0). Structured the same way as `IDBCursor` -- a public
+ *   constructor that always throws, with real instances only ever produced
+ *   internally via `__createInstance` -- so a record can't be directly
+ *   instantiated by script.
+ * @see https://w3c.github.io/IndexedDB/#record-interface
+ * @throws {TypeError}
+ * @class
+ */
+function IDBRecord () {
+    throw new TypeError('Illegal constructor');
+}
+const IDBRecordAlias = IDBRecord;
+
+/**
+ * @param {import('./Key.js').Key} key
+ * @param {import('./Key.js').Key} primaryKey
+ * @param {import('./Key.js').Value} value
+ * @returns {IDBRecordFull}
+ */
+IDBRecord.__createInstance = function (key, primaryKey, value) {
+    /**
+     * @class
+     * @this {IDBRecordFull}
+     */
+    function IDBRecord () {
+        // @ts-ignore Should be ok
+        this[Symbol.toStringTag] = 'IDBRecord';
+        this.__key = key;
+        this.__primaryKey = primaryKey;
+        this.__value = value;
+    }
+    IDBRecord.prototype = IDBRecordAlias.prototype;
+
+    // @ts-expect-error Properties added below on the shared prototype
+    return new IDBRecord();
+};
+
+IDBRecord.prototype[Symbol.toStringTag] = 'IDBRecordPrototype';
+
+/* eslint-disable unicorn/no-top-level-side-effects -- Would be good */
+util.setOperationNames(IDBRecord.prototype);
+util.setOperationNames(IDBRecord);
+
+// Defined once on the shared prototype (rather than per-instance, as
+//   `util.defineReadonlyProperties` would) since WPT's `assert_idl_attribute`
+//   specifically requires these to be inherited, not own, properties.
+readonlyProperties.forEach((prop) => {
+    Object.defineProperty(IDBRecord.prototype, '__' + prop, {
+        enumerable: false,
+        configurable: false,
+        writable: true
+    });
+    // We must resort to this to get "get <name>" as the function `name` for
+    //   proper IDL.
+    const o = {
+        /**
+         * @returns {import('./Key.js').Key|import('./Key.js').Value}
+         */
+        get [prop] () {
+            return this['__' + prop];
+        }
+    };
+    const desc = /** @type {PropertyDescriptor} */ (
+        Object.getOwnPropertyDescriptor(o, prop)
+    );
+    Object.defineProperty(IDBRecord.prototype, prop, desc);
+});
+
+Object.defineProperty(IDBRecord, 'prototype', {
+    writable: false
+});
+/* eslint-enable unicorn/no-top-level-side-effects -- Would be good */
+
+export {IDBRecord};
+
+export default IDBRecord;

package/src/IDBRequest.js

@@ -17,7 +17,7 @@ function IDBRequest () {
 }
 
 /**
- * @typedef {IDBRequest & EventTarget & import('eventtargeter').ShimEventTarget & {
+ * @typedef {IDBRequest & EventTarget & import('eventtargeter').EventTargetInstance & {
  *   transaction: import('./IDBTransaction.js').IDBTransactionFull,
  *   __done: boolean,
  *   __result: import('./IDBDatabase.js').IDBDatabaseFull|undefined,
@@ -42,9 +42,9 @@ function IDBRequest () {
  * @this {IDBRequestFull}
  */
 IDBRequest.__super = function IDBRequest () {
-    // @ts-expect-error It's ok
+    // @ts-ignore It's ok
     this[Symbol.toStringTag] = 'IDBRequest';
-    // @ts-expect-error Part of `ShimEventTarget`
+    // @ts-ignore Part of `ShimEventTarget`
     this.__setOptions({
         legacyOutputDidListenersThrowFlag: true // Event hook for IndexedB
     });
@@ -73,11 +73,11 @@ IDBRequest.__super = function IDBRequest () {
     util.defineReadonlyProperties(this, readonlyProperties, {
         readyState: {
             /**
-             * @this {IDBRequestFull}
              * @returns {"done"|"pending"}
              */
             get readyState () {
-                return this.__done ? 'done' : 'pending';
+                const me = /** @type {IDBRequestFull} */ (/** @type {unknown} */ (this));
+                return me.__done ? 'done' : 'pending';
             }
         }
     });
@@ -171,9 +171,9 @@ IDBOpenDBRequest.__createInstance = function () {
     function IDBOpenDBRequest () {
         IDBRequest.__super.call(this);
 
-        // @ts-expect-error It's ok
+        // @ts-ignore It's ok
         this[Symbol.toStringTag] = 'IDBOpenDBRequest';
-        // @ts-expect-error It's ok
+        // @ts-ignore It's ok
         this.__setOptions({
             legacyOutputDidListenersThrowFlag: true, // Event hook for IndexedB
             extraProperties: ['oldVersion', 'newVersion', 'debug']