@converse/skeletor 3.1.4 → 3.1.5

package/dist/skeletor.node.mjs

@@ -334,7 +334,7 @@ function getKeyPrefix(options, defaultConfig) {
     return (options.name || defaultConfig.name) + "/" + (options.storeName || defaultConfig.storeName) + "/";
 }
 
-function executeCallback$1(promise, callback) {
+function executeCallback(promise, callback) {
     if (callback) {
         promise.then(function (result) {
             callback(null, result);
@@ -475,7 +475,7 @@ function clear$1(callback) {
     var promise = this.ready().then(function () {
         _this._dbInfo.mStore.clear();
     });
-    executeCallback$1(promise, callback);
+    executeCallback(promise, callback);
     return promise;
 }
 
@@ -484,7 +484,7 @@ function dropInstance$1(_options, _cb) {
     var outPromise = promise.then(function (keyPrefix) {
         Store.resolve(keyPrefix).drop();
     });
-    executeCallback$1(outPromise, callback);
+    executeCallback(outPromise, callback);
     return promise;
 }
 
@@ -496,7 +496,7 @@ function getItem$1(key$, callback) {
         // Deserialise if the result is not null or undefined
         return result == null ? null : _this._dbInfo.serializer.deserialize(result); //tslint:disable-line:triple-equals
     });
-    executeCallback$1(promise, callback);
+    executeCallback(promise, callback);
     return promise;
 }
 
@@ -520,7 +520,7 @@ function iterate$1(iterator, callback) {
             }
         }
     });
-    executeCallback$1(promise, callback);
+    executeCallback(promise, callback);
     return promise;
 }
 
@@ -539,7 +539,7 @@ function key$1(idx, callback) {
         }
         return result;
     });
-    executeCallback$1(promise, callback);
+    executeCallback(promise, callback);
     return promise;
 }
 
@@ -548,13 +548,13 @@ function keys$2(callback) {
     var promise = this.ready().then(function () {
         return _this._dbInfo.mStore.keys();
     });
-    executeCallback$1(promise, callback);
+    executeCallback(promise, callback);
     return promise;
 }
 
 function length$1(callback) {
     var promise = this.keys().then(function (keys$) { return keys$.length; });
-    executeCallback$1(promise, callback);
+    executeCallback(promise, callback);
     return promise;
 }
 
@@ -564,7 +564,7 @@ function removeItem$1(key$, callback) {
     var promise = this.ready().then(function () {
         _this._dbInfo.mStore.rm(key$);
     });
-    executeCallback$1(promise, callback);
+    executeCallback(promise, callback);
     return promise;
 }
 
@@ -594,7 +594,7 @@ function setItem$1(key$, value, callback) {
             });
         });
     });
-    executeCallback$1(promise, callback);
+    executeCallback(promise, callback);
     return promise;
 }
 
@@ -7104,253 +7104,282 @@ function requireLocalforageSetitems () {
 
 var localforageSetitemsExports = requireLocalforageSetitems();
 
-function getSerializerPromise(localForageInstance) {
-    if (getSerializerPromise.result) {
-        return getSerializerPromise.result;
-    }
-    if (!localForageInstance || typeof localForageInstance.getSerializer !== 'function') {
-        return Promise.reject(new Error('localforage.getSerializer() was not available! ' + 'localforage v1.4+ is required!'));
-    }
-    getSerializerPromise.result = localForageInstance.getSerializer();
-    return getSerializerPromise.result;
-}
+var localforageGetitems$1 = {exports: {}};
 
+var localforageGetitems = localforageGetitems$1.exports;
 
+var hasRequiredLocalforageGetitems;
 
-function executeCallback(promise, callback) {
-    if (callback) {
-        promise.then(function (result) {
-            callback(null, result);
-        }, function (error) {
-            callback(error);
-        });
-    }
-    return promise;
-}
+function requireLocalforageGetitems () {
+	if (hasRequiredLocalforageGetitems) return localforageGetitems$1.exports;
+	hasRequiredLocalforageGetitems = 1;
+	(function (module, exports) {
+		(function (global, factory) {
+		    factory(exports, requireLocalforage()) ;
+		}(localforageGetitems, (function (exports,localforage) {
+		localforage = 'default' in localforage ? localforage['default'] : localforage;
 
-function getItemKeyValue(key, callback) {
-    var localforageInstance = this;
-    var promise = localforageInstance.getItem(key).then(function (value) {
-        return {
-            key: key,
-            value: value
-        };
-    });
-    executeCallback(promise, callback);
-    return promise;
-}
+		function getSerializerPromise(localForageInstance) {
+		    if (getSerializerPromise.result) {
+		        return getSerializerPromise.result;
+		    }
+		    if (!localForageInstance || typeof localForageInstance.getSerializer !== 'function') {
+		        return Promise.reject(new Error('localforage.getSerializer() was not available! ' + 'localforage v1.4+ is required!'));
+		    }
+		    getSerializerPromise.result = localForageInstance.getSerializer();
+		    return getSerializerPromise.result;
+		}
 
-function getItemsGeneric(keys /*, callback*/) {
-    var localforageInstance = this;
-    var promise = new Promise(function (resolve, reject) {
-        var itemPromises = [];
 
-        for (var i = 0, len = keys.length; i < len; i++) {
-            itemPromises.push(getItemKeyValue.call(localforageInstance, keys[i]));
-        }
 
-        Promise.all(itemPromises).then(function (keyValuePairs) {
-            var result = {};
-            for (var i = 0, len = keyValuePairs.length; i < len; i++) {
-                var keyValuePair = keyValuePairs[i];
+		function executeCallback(promise, callback) {
+		    if (callback) {
+		        promise.then(function (result) {
+		            callback(null, result);
+		        }, function (error) {
+		            callback(error);
+		        });
+		    }
+		    return promise;
+		}
 
-                result[keyValuePair.key] = keyValuePair.value;
-            }
-            resolve(result);
-        }).catch(reject);
-    });
-    return promise;
-}
+		function getItemKeyValue(key, callback) {
+		    var localforageInstance = this;
+		    var promise = localforageInstance.getItem(key).then(function (value) {
+		        return {
+		            key: key,
+		            value: value
+		        };
+		    });
+		    executeCallback(promise, callback);
+		    return promise;
+		}
 
+		function getItemsGeneric(keys /*, callback*/) {
+		    var localforageInstance = this;
+		    var promise = new Promise(function (resolve, reject) {
+		        var itemPromises = [];
 
+		        for (var i = 0, len = keys.length; i < len; i++) {
+		            itemPromises.push(getItemKeyValue.call(localforageInstance, keys[i]));
+		        }
 
+		        Promise.all(itemPromises).then(function (keyValuePairs) {
+		            var result = {};
+		            for (var i = 0, len = keyValuePairs.length; i < len; i++) {
+		                var keyValuePair = keyValuePairs[i];
 
+		                result[keyValuePair.key] = keyValuePair.value;
+		            }
+		            resolve(result);
+		        }).catch(reject);
+		    });
+		    return promise;
+		}
 
-function getAllItemsUsingIterate() {
-    var localforageInstance = this;
-    var accumulator = {};
-    return localforageInstance.iterate(function (value, key /*, iterationNumber*/) {
-        accumulator[key] = value;
-    }).then(function () {
-        return accumulator;
-    });
-}
 
-function getIDBKeyRange() {
-    /* global IDBKeyRange, webkitIDBKeyRange, mozIDBKeyRange */
-    if (typeof IDBKeyRange !== 'undefined') {
-        return IDBKeyRange;
-    }
-    if (typeof webkitIDBKeyRange !== 'undefined') {
-        return webkitIDBKeyRange;
-    }
-    if (typeof mozIDBKeyRange !== 'undefined') {
-        return mozIDBKeyRange;
-    }
-}
 
-var idbKeyRange = getIDBKeyRange();
 
-function getItemsIndexedDB(keys /*, callback*/) {
-    keys = keys.slice();
-    var localforageInstance = this;
-    function comparer(a, b) {
-        return a < b ? -1 : a > b ? 1 : 0;
-    }
 
-    var promise = new Promise(function (resolve, reject) {
-        localforageInstance.ready().then(function () {
-            // Thanks https://hacks.mozilla.org/2014/06/breaking-the-borders-of-indexeddb/
-            var dbInfo = localforageInstance._dbInfo;
-            var store = dbInfo.db.transaction(dbInfo.storeName, 'readonly').objectStore(dbInfo.storeName);
+		function getAllItemsUsingIterate() {
+		    var localforageInstance = this;
+		    var accumulator = {};
+		    return localforageInstance.iterate(function (value, key /*, iterationNumber*/) {
+		        accumulator[key] = value;
+		    }).then(function () {
+		        return accumulator;
+		    });
+		}
 
-            var set = keys.sort(comparer);
+		function getIDBKeyRange() {
+		    /* global IDBKeyRange, webkitIDBKeyRange, mozIDBKeyRange */
+		    if (typeof IDBKeyRange !== 'undefined') {
+		        return IDBKeyRange;
+		    }
+		    if (typeof webkitIDBKeyRange !== 'undefined') {
+		        return webkitIDBKeyRange;
+		    }
+		    if (typeof mozIDBKeyRange !== 'undefined') {
+		        return mozIDBKeyRange;
+		    }
+		}
 
-            var keyRangeValue = idbKeyRange.bound(keys[0], keys[keys.length - 1], false, false);
+		var idbKeyRange = getIDBKeyRange();
 
-            var req;
+		function getItemsIndexedDB(keys /*, callback*/) {
+		    keys = keys.slice();
+		    var localforageInstance = this;
+		    function comparer(a, b) {
+		        return a < b ? -1 : a > b ? 1 : 0;
+		    }
 
-            if ('getAll' in store) {
-                req = store.getAll(keyRangeValue);
-                req.onsuccess = function () {
-                    var value = req.result;
-                    if (value === undefined) {
-                        value = null;
-                    }
-                    resolve(value);
-                };
-            } else {
-                req = store.openCursor(keyRangeValue);
-                var result = {};
-                var i = 0;
+		    var promise = new Promise(function (resolve, reject) {
+		        localforageInstance.ready().then(function () {
+		            // Thanks https://hacks.mozilla.org/2014/06/breaking-the-borders-of-indexeddb/
+		            var dbInfo = localforageInstance._dbInfo;
+		            var store = dbInfo.db.transaction(dbInfo.storeName, 'readonly').objectStore(dbInfo.storeName);
 
-                req.onsuccess = function () /*event*/{
-                    var cursor = req.result; // event.target.result;
+		            var set = keys.sort(comparer);
 
-                    if (!cursor) {
-                        resolve(result);
-                        return;
-                    }
+		            var keyRangeValue = idbKeyRange.bound(keys[0], keys[keys.length - 1], false, false);
 
-                    var key = cursor.key;
+		            var req;
 
-                    while (key > set[i]) {
-                        i++; // The cursor has passed beyond this key. Check next.
+		            if ('getAll' in store) {
+		                req = store.getAll(keyRangeValue);
+		                req.onsuccess = function () {
+		                    var value = req.result;
+		                    if (value === undefined) {
+		                        value = null;
+		                    }
+		                    resolve(value);
+		                };
+		            } else {
+		                req = store.openCursor(keyRangeValue);
+		                var result = {};
+		                var i = 0;
 
-                        if (i === set.length) {
-                            // There is no next. Stop searching.
-                            resolve(result);
-                            return;
-                        }
-                    }
+		                req.onsuccess = function () /*event*/{
+		                    var cursor = req.result; // event.target.result;
 
-                    if (key === set[i]) {
-                        // The current cursor value should be included and we should continue
-                        // a single step in case next item has the same key or possibly our
-                        // next key in set.
-                        var value = cursor.value;
-                        if (value === undefined) {
-                            value = null;
-                        }
+		                    if (!cursor) {
+		                        resolve(result);
+		                        return;
+		                    }
 
-                        result[key] = value;
-                        // onfound(cursor.value);
-                        cursor.continue();
-                    } else {
-                        // cursor.key not yet at set[i]. Forward cursor to the next key to hunt for.
-                        cursor.continue(set[i]);
-                    }
-                };
-            }
+		                    var key = cursor.key;
 
-            req.onerror = function () /*event*/{
-                reject(req.error);
-            };
-        }).catch(reject);
-    });
-    return promise;
-}
+		                    while (key > set[i]) {
+		                        i++; // The cursor has passed beyond this key. Check next.
 
-function getItemsWebsql(keys /*, callback*/) {
-    var localforageInstance = this;
-    var promise = new Promise(function (resolve, reject) {
-        localforageInstance.ready().then(function () {
-            return getSerializerPromise(localforageInstance);
-        }).then(function (serializer) {
-            var dbInfo = localforageInstance._dbInfo;
-            dbInfo.db.transaction(function (t) {
+		                        if (i === set.length) {
+		                            // There is no next. Stop searching.
+		                            resolve(result);
+		                            return;
+		                        }
+		                    }
 
-                var queryParts = new Array(keys.length);
-                for (var i = 0, len = keys.length; i < len; i++) {
-                    queryParts[i] = '?';
-                }
+		                    if (key === set[i]) {
+		                        // The current cursor value should be included and we should continue
+		                        // a single step in case next item has the same key or possibly our
+		                        // next key in set.
+		                        var value = cursor.value;
+		                        if (value === undefined) {
+		                            value = null;
+		                        }
 
-                t.executeSql('SELECT * FROM ' + dbInfo.storeName + ' WHERE (key IN (' + queryParts.join(',') + '))', keys, function (t, results) {
+		                        result[key] = value;
+		                        // onfound(cursor.value);
+		                        cursor.continue();
+		                    } else {
+		                        // cursor.key not yet at set[i]. Forward cursor to the next key to hunt for.
+		                        cursor.continue(set[i]);
+		                    }
+		                };
+		            }
 
-                    var result = {};
+		            req.onerror = function () /*event*/{
+		                reject(req.error);
+		            };
+		        }).catch(reject);
+		    });
+		    return promise;
+		}
 
-                    var rows = results.rows;
-                    for (var i = 0, len = rows.length; i < len; i++) {
-                        var item = rows.item(i);
-                        var value = item.value;
+		function getItemsWebsql(keys /*, callback*/) {
+		    var localforageInstance = this;
+		    var promise = new Promise(function (resolve, reject) {
+		        localforageInstance.ready().then(function () {
+		            return getSerializerPromise(localforageInstance);
+		        }).then(function (serializer) {
+		            var dbInfo = localforageInstance._dbInfo;
+		            dbInfo.db.transaction(function (t) {
 
-                        // Check to see if this is serialized content we need to
-                        // unpack.
-                        if (value) {
-                            value = serializer.deserialize(value);
-                        }
+		                var queryParts = new Array(keys.length);
+		                for (var i = 0, len = keys.length; i < len; i++) {
+		                    queryParts[i] = '?';
+		                }
 
-                        result[item.key] = value;
-                    }
+		                t.executeSql('SELECT * FROM ' + dbInfo.storeName + ' WHERE (key IN (' + queryParts.join(',') + '))', keys, function (t, results) {
 
-                    resolve(result);
-                }, function (t, error) {
-                    reject(error);
-                });
-            });
-        }).catch(reject);
-    });
-    return promise;
-}
+		                    var result = {};
 
-function localforageGetItems(keys, callback) {
-    var localforageInstance = this;
+		                    var rows = results.rows;
+		                    for (var i = 0, len = rows.length; i < len; i++) {
+		                        var item = rows.item(i);
+		                        var value = item.value;
 
-    var promise;
-    if (!arguments.length || keys === null) {
-        promise = getAllItemsUsingIterate.apply(localforageInstance);
-    } else {
-        var currentDriver = localforageInstance.driver();
-        if (currentDriver === localforageInstance.INDEXEDDB) {
-            promise = getItemsIndexedDB.apply(localforageInstance, arguments);
-        } else if (currentDriver === localforageInstance.WEBSQL) {
-            promise = getItemsWebsql.apply(localforageInstance, arguments);
-        } else {
-            promise = getItemsGeneric.apply(localforageInstance, arguments);
-        }
-    }
+		                        // Check to see if this is serialized content we need to
+		                        // unpack.
+		                        if (value) {
+		                            value = serializer.deserialize(value);
+		                        }
 
-    executeCallback(promise, callback);
-    return promise;
-}
+		                        result[item.key] = value;
+		                    }
 
-function extendPrototype(localforage$$1) {
-    var localforagePrototype = Object.getPrototypeOf(localforage$$1);
-    if (localforagePrototype) {
-        localforagePrototype.getItems = localforageGetItems;
-        localforagePrototype.getItems.indexedDB = function () {
-            return getItemsIndexedDB.apply(this, arguments);
-        };
-        localforagePrototype.getItems.websql = function () {
-            return getItemsWebsql.apply(this, arguments);
-        };
-        localforagePrototype.getItems.generic = function () {
-            return getItemsGeneric.apply(this, arguments);
-        };
-    }
+		                    resolve(result);
+		                }, function (t, error) {
+		                    reject(error);
+		                });
+		            });
+		        }).catch(reject);
+		    });
+		    return promise;
+		}
+
+		function localforageGetItems(keys, callback) {
+		    var localforageInstance = this;
+
+		    var promise;
+		    if (!arguments.length || keys === null) {
+		        promise = getAllItemsUsingIterate.apply(localforageInstance);
+		    } else {
+		        var currentDriver = localforageInstance.driver();
+		        if (currentDriver === localforageInstance.INDEXEDDB) {
+		            promise = getItemsIndexedDB.apply(localforageInstance, arguments);
+		        } else if (currentDriver === localforageInstance.WEBSQL) {
+		            promise = getItemsWebsql.apply(localforageInstance, arguments);
+		        } else {
+		            promise = getItemsGeneric.apply(localforageInstance, arguments);
+		        }
+		    }
+
+		    executeCallback(promise, callback);
+		    return promise;
+		}
+
+		function extendPrototype(localforage$$1) {
+		    var localforagePrototype = Object.getPrototypeOf(localforage$$1);
+		    if (localforagePrototype) {
+		        localforagePrototype.getItems = localforageGetItems;
+		        localforagePrototype.getItems.indexedDB = function () {
+		            return getItemsIndexedDB.apply(this, arguments);
+		        };
+		        localforagePrototype.getItems.websql = function () {
+		            return getItemsWebsql.apply(this, arguments);
+		        };
+		        localforagePrototype.getItems.generic = function () {
+		            return getItemsGeneric.apply(this, arguments);
+		        };
+		    }
+		}
+
+		var extendPrototypeResult = extendPrototype(localforage);
+
+		exports.localforageGetItems = localforageGetItems;
+		exports.extendPrototype = extendPrototype;
+		exports.extendPrototypeResult = extendPrototypeResult;
+		exports.getItemsGeneric = getItemsGeneric;
+
+		Object.defineProperty(exports, '__esModule', { value: true });
+
+		}))); 
+	} (localforageGetitems$1, localforageGetitems$1.exports));
+	return localforageGetitems$1.exports;
 }
 
-extendPrototype(localForage);
+var localforageGetitemsExports = requireLocalforageGetitems();
 
 /** Used for built-in method references. */
 var objectProto$8 = Object.prototype;
@@ -7901,7 +7930,7 @@ function sync(method, model, options = {}) {
 const IN_MEMORY = _driver;
 localForage.defineDriver(memoryDriver);
 localforageSetitemsExports.extendPrototype(localForage);
-extendPrototype(localForage);
+localforageGetitemsExports.extendPrototype(localForage);
 // Every storage instance is registered with a WeakRef so that flushAll() can
 // reach pending writes without keeping instances alive. There's no leak and no
 // lifecycle hook to maintain: an instance is collected once its owning model or
@@ -8091,33 +8120,17 @@ class PersistentStorage {
                     caughtError = error instanceof Error ? error : new Error(error?.message ?? String(error));
                 }
             }
-            if (resp) {
-                if (options && options.success) {
-                    // When storing, we don't pass back the response (which is
-                    // the set attributes returned from localforage because
-                    // Skeletor sets them again on the model and due to the async
-                    // nature of localforage it can cause stale attributes to be
-                    // set on a model after it's been updated in the meantime.
-                    const data = method === 'read' ? resp : null;
-                    options.success(data, options);
-                }
-            }
-            else if (method === 'read' && !caughtError) {
-                // A read that finds no record is a normal empty result (first run /
-                // empty storage), not an error. Resolve with `null` so the callback
-                // and promise forms of fetch() agree and a first-run read never
-                // rejects.
-                if (options && options.success) {
-                    options.success(null, options);
-                }
+            if (caughtError) {
+                options?.error?.(caughtError);
             }
-            else {
-                // A genuine failure (storage threw, or a write produced no result):
-                // surface a real Error so consumers get a stack and `instanceof Error`
-                // holds.
-                if (options && options.error) {
-                    options.error(caughtError ?? new Error('Record Not Found'));
-                }
+            else if (options?.success) {
+                // When storing, we don't pass back the response (which is the set
+                // attributes returned from localforage) because Skeletor sets them
+                // again on the model and due to the async nature of localforage it can
+                // cause stale attributes to be set on a model after it's been updated
+                // in the meantime.
+                const data = method === 'read' ? (resp ?? null) : null;
+                options.success(data, options);
             }
         }
         localSync.__name__ = 'localSync';
@@ -8319,7 +8332,7 @@ class NodeSQLiteStorage {
             }
             throw e;
         }
-        return Promise.resolve();
+        return Promise.resolve(items);
     }
     getItems(keys) {
         if (keys.length === 0) {

package/package.json

@@ -9,6 +9,7 @@
   "browser": "dist/skeletor.js",
   "exports": {
     ".": {
+      "types": "./dist/skeletor.d.ts",
       "node": {
         "require": "./dist/skeletor.node.js",
         "import": "./dist/skeletor.node.mjs"
@@ -19,6 +20,7 @@
       }
     },
     "./node": {
+      "types": "./dist/skeletor.d.ts",
       "require": "./dist/skeletor.node.js",
       "import": "./dist/skeletor.node.mjs"
     }
@@ -36,7 +38,7 @@
   "contributors": [
     "JC Brand"
   ],
-  "version": "3.1.4",
+  "version": "3.1.5",
   "engines": {
     "node": ">=22.0.0"
   },

package/src/declarations.d.ts

@@ -0,0 +1,11 @@
+/**
+ * `@converse/localforage-getitems` ships its types as an ambient script that
+ * declares the *unscoped* module name (`localforage-getitems`), left over from
+ * the package it was forked from. TypeScript therefore resolves the scoped
+ * specifier to a `typings/index.d.ts` that isn't a module (TS2306), so declare
+ * the shape we use here instead.
+ */
+declare module '@converse/localforage-getitems' {
+  export function extendPrototype<T>(localforage: T): T;
+  export const extendPrototypeResult: boolean;
+}