@converse/skeletor 0.0.8 → 1.0.0

package/src/drivers/sessionStorage.js

@@ -1,306 +0,0 @@
-// Copyright 2014 Mozilla
-// Copyright 2015 Thodoris Greasidis
-// Copyright 2018 JC Brand
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-import executeCallback from 'localforage/src/utils/executeCallback';
-import getCallback from 'localforage/src/utils/getCallback';
-import normalizeKey from 'localforage/src/utils/normalizeKey';
-import serializer from 'localforage/src/utils/serializer';
-
-const serialize = serializer["serialize"];
-const deserialize = serializer["deserialize"];
-
-
-function isSessionStorageValid () {
-    // If the app is running inside a Google Chrome packaged webapp, or some
-    // other context where sessionStorage isn't available, we don't use
-    // sessionStorage. This feature detection is preferred over the old
-    // `if (window.chrome && window.chrome.runtime)` code.
-    // See: https://github.com/mozilla/localForage/issues/68
-    try {
-        // If sessionStorage isn't available, we get outta here!
-        // This should be inside a try catch
-        if (sessionStorage && ('setItem' in sessionStorage)) {
-            return true;
-        }
-    } catch (e) {
-        console.log(e);
-    }
-    return false;
-}
-
-function _getKeyPrefix(options, defaultConfig) {
-    let keyPrefix = options.name + '/';
-
-    if (options.storeName !== defaultConfig.storeName) {
-        keyPrefix += options.storeName + '/';
-    }
-    return keyPrefix;
-}
-
-const dbInfo = {
-    'serializer': {
-        'serialize': serialize,
-        'deserialize': deserialize
-    }
-};
-
-function _initStorage(options) {
-    dbInfo.keyPrefix = _getKeyPrefix(options, this._defaultConfig);
-    if (options) {
-        for (const i in options) { // eslint-disable-line guard-for-in
-            dbInfo[i] = options[i];
-        }
-    }
-}
-
-// Remove all keys from the datastore, effectively destroying all data in
-// the app's key/value store!
-function clear(callback) {
-    const promise = this.ready().then(function() {
-        const keyPrefix = dbInfo.keyPrefix;
-
-        for (let i = sessionStorage.length - 1; i >= 0; i--) {
-            const key = sessionStorage.key(i);
-
-            if (key.indexOf(keyPrefix) === 0) {
-                sessionStorage.removeItem(key);
-            }
-        }
-    });
-
-    executeCallback(promise, callback);
-    return promise;
-}
-
-// Retrieve an item from the store. Unlike the original async_storage
-// library in Gaia, we don't modify return values at all. If a key's value
-// is `undefined`, we pass that value to the callback function.
-function getItem(key, callback) {
-    key = normalizeKey(key);
-
-    const promise = this.ready().then(function() {
-        let result = sessionStorage.getItem(dbInfo.keyPrefix + key);
-        // If a result was found, parse it from the serialized
-        // string into a JS object. If result isn't truthy, the key
-        // is likely undefined and we'll pass it straight to the
-        // callback.
-        if (result) {
-            result = dbInfo.serializer.deserialize(result);
-        }
-        return result;
-    });
-    executeCallback(promise, callback);
-    return promise;
-}
-
-// Iterate over all items in the store.
-function iterate(iterator, callback) {
-    const self = this;
-
-    const promise = self.ready().then(function() {
-        const keyPrefix = dbInfo.keyPrefix;
-        const keyPrefixLength = keyPrefix.length;
-        const length = sessionStorage.length;
-
-        // We use a dedicated iterator instead of the `i` variable below
-        // so other keys we fetch in sessionStorage aren't counted in
-        // the `iterationNumber` argument passed to the `iterate()`
-        // callback.
-        //
-        // See: github.com/mozilla/localForage/pull/435#discussion_r38061530
-        let iterationNumber = 1;
-
-        for (let i = 0; i < length; i++) {
-            const key = sessionStorage.key(i);
-            if (key.indexOf(keyPrefix) !== 0) {
-                continue;
-            }
-            let value = sessionStorage.getItem(key);
-
-            // If a result was found, parse it from the serialized
-            // string into a JS object. If result isn't truthy, the
-            // key is likely undefined and we'll pass it straight
-            // to the iterator.
-            if (value) {
-                value = dbInfo.serializer.deserialize(value);
-            }
-
-            value = iterator(
-                value,
-                key.substring(keyPrefixLength),
-                iterationNumber++
-            );
-
-            if (value !== void 0) { // eslint-disable-line no-void
-                return value;
-            }
-        }
-    });
-
-    executeCallback(promise, callback);
-    return promise;
-}
-
-// Same as sessionStorage's key() method, except takes a callback.
-function key(n, callback) {
-    const self = this;
-    const promise = self.ready().then(function() {
-        let result;
-        try {
-            result = sessionStorage.key(n);
-        } catch (error) {
-            result = null;
-        }
-
-        // Remove the prefix from the key, if a key is found.
-        if (result) {
-            result = result.substring(dbInfo.keyPrefix.length);
-        }
-
-        return result;
-    });
-
-    executeCallback(promise, callback);
-    return promise;
-}
-
-function keys(callback) {
-    const self = this;
-    const promise = self.ready().then(function() {
-        const length = sessionStorage.length;
-        const keys = [];
-
-        for (let i = 0; i < length; i++) {
-            const itemKey = sessionStorage.key(i);
-            if (itemKey.indexOf(dbInfo.keyPrefix) === 0) {
-                keys.push(itemKey.substring(dbInfo.keyPrefix.length));
-            }
-        }
-        return keys;
-    });
-
-    executeCallback(promise, callback);
-    return promise;
-}
-
-// Supply the number of keys in the datastore to the callback function.
-function length(callback) {
-    const self = this;
-    const promise = self.keys().then(function(keys) {
-        return keys.length;
-    });
-
-    executeCallback(promise, callback);
-    return promise;
-}
-
-// Remove an item from the store, nice and simple.
-function removeItem(key, callback) {
-    key = normalizeKey(key);
-    const promise = this.ready().then(function() {
-        sessionStorage.removeItem(dbInfo.keyPrefix + key);
-    });
-    executeCallback(promise, callback);
-    return promise;
-}
-
-// Set a key's value and run an optional callback once the value is set.
-// Unlike Gaia's implementation, the callback function is passed the value,
-// in case you want to operate on that value only after you're sure it
-// saved, or something like that.
-async function setItem(key, value, callback) {
-    key = normalizeKey(key);
-    await this.ready();
-
-    // Convert undefined values to null.
-    // https://github.com/mozilla/localForage/pull/42
-    value = value ?? null;
-
-    // Save the original value to pass to the callback.
-    const originalValue = value;
-
-    dbInfo.serializer.serialize(value, (value, error) => {
-        if (error) {
-            throw error;
-        } else {
-            try {
-                sessionStorage.setItem(dbInfo.keyPrefix + key, value);
-                executeCallback(Promise.resolve(originalValue), callback);
-            } catch (e) {
-                if (
-                    e.name === 'QuotaExceededError' ||
-                    e.name === 'NS_ERROR_DOM_QUOTA_REACHED'
-                ) {
-                    console.error("Your sesionStorage capacity is used up.");
-                    throw e;
-                }
-                throw e;
-            }
-        }
-    });
-}
-
-function dropInstance(options, callback) {
-    callback = getCallback.apply(this, arguments);
-
-    options = (typeof options !== 'function' && options) || {};
-    if (!options.name) {
-        const currentConfig = this.config();
-        options.name = options.name || currentConfig.name;
-        options.storeName = options.storeName || currentConfig.storeName;
-    }
-
-    const self = this;
-    let promise;
-    if (!options.name) {
-        promise = Promise.reject(new Error('Invalid arguments'));
-    } else {
-        promise = new Promise(function(resolve) {
-            if (!options.storeName) {
-                resolve(`${options.name}/`);
-            } else {
-                resolve(_getKeyPrefix(options, self._defaultConfig));
-            }
-        }).then(function(keyPrefix) {
-            for (let i = sessionStorage.length - 1; i >= 0; i--) {
-                const key = sessionStorage.key(i);
-                if (key.indexOf(keyPrefix) === 0) {
-                    sessionStorage.removeItem(key);
-                }
-            }
-        });
-    }
-
-    executeCallback(promise, callback);
-    return promise;
-}
-
-const sessionStorageWrapper = {
-    _driver: 'sessionStorageWrapper',
-    _initStorage: _initStorage,
-    _support: isSessionStorageValid(),
-    iterate: iterate,
-    getItem: getItem,
-    setItem: setItem,
-    removeItem: removeItem,
-    clear: clear,
-    length: length,
-    key: key,
-    keys: keys,
-    dropInstance: dropInstance
-};
-
-export default sessionStorageWrapper;

package/src/drivers/sessionStorage.js~

@@ -1,307 +0,0 @@
-// Copyright 2014 Mozilla
-// Copyright 2015 Thodoris Greasidis
-// Copyright 2018 JC Brand
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-import executeCallback from 'localforage/src/utils/executeCallback';
-import getCallback from 'localforage/src/utils/getCallback';
-import normalizeKey from 'localforage/src/utils/normalizeKey';
-import serializer from 'localforage/src/utils/serializer';
-
-const serialize = serializer["serialize"];
-const deserialize = serializer["deserialize"];
-
-
-function isSessionStorageValid () {
-    // If the app is running inside a Google Chrome packaged webapp, or some
-    // other context where sessionStorage isn't available, we don't use
-    // sessionStorage. This feature detection is preferred over the old
-    // `if (window.chrome && window.chrome.runtime)` code.
-    // See: https://github.com/mozilla/localForage/issues/68
-    try {
-        // If sessionStorage isn't available, we get outta here!
-        // This should be inside a try catch
-        if (sessionStorage && ('setItem' in sessionStorage)) {
-            return true;
-        }
-    } catch (e) {
-        console.log(e);
-    }
-    return false;
-}
-
-function _getKeyPrefix(options, defaultConfig) {
-    let keyPrefix = options.name + '/';
-
-    if (options.storeName !== defaultConfig.storeName) {
-        keyPrefix += options.storeName + '/';
-    }
-    return keyPrefix;
-}
-
-const dbInfo = {
-    'serializer': {
-        'serialize': serialize,
-        'deserialize': deserialize
-    }
-};
-
-function _initStorage(options) {
-    dbInfo.keyPrefix = _getKeyPrefix(options, this._defaultConfig);
-    if (options) {
-        for (const i in options) { // eslint-disable-line guard-for-in
-            dbInfo[i] = options[i];
-        }
-    }
-}
-
-// Remove all keys from the datastore, effectively destroying all data in
-// the app's key/value store!
-function clear(callback) {
-    const promise = this.ready().then(function() {
-        const keyPrefix = dbInfo.keyPrefix;
-
-        for (let i = sessionStorage.length - 1; i >= 0; i--) {
-            const key = sessionStorage.key(i);
-
-            if (key.indexOf(keyPrefix) === 0) {
-                sessionStorage.removeItem(key);
-            }
-        }
-    });
-
-    executeCallback(promise, callback);
-    return promise;
-}
-
-// Retrieve an item from the store. Unlike the original async_storage
-// library in Gaia, we don't modify return values at all. If a key's value
-// is `undefined`, we pass that value to the callback function.
-function getItem(key, callback) {
-    key = normalizeKey(key);
-
-    const promise = this.ready().then(function() {
-        let result = sessionStorage.getItem(dbInfo.keyPrefix + key);
-        // If a result was found, parse it from the serialized
-        // string into a JS object. If result isn't truthy, the key
-        // is likely undefined and we'll pass it straight to the
-        // callback.
-        if (result) {
-            result = dbInfo.serializer.deserialize(result);
-        }
-        return result;
-    });
-    executeCallback(promise, callback);
-    return promise;
-}
-
-// Iterate over all items in the store.
-function iterate(iterator, callback) {
-    const self = this;
-
-    const promise = self.ready().then(function() {
-        const keyPrefix = dbInfo.keyPrefix;
-        const keyPrefixLength = keyPrefix.length;
-        const length = sessionStorage.length;
-
-        // We use a dedicated iterator instead of the `i` variable below
-        // so other keys we fetch in sessionStorage aren't counted in
-        // the `iterationNumber` argument passed to the `iterate()`
-        // callback.
-        //
-        // See: github.com/mozilla/localForage/pull/435#discussion_r38061530
-        let iterationNumber = 1;
-
-        for (let i = 0; i < length; i++) {
-            const key = sessionStorage.key(i);
-            if (key.indexOf(keyPrefix) !== 0) {
-                continue;
-            }
-            let value = sessionStorage.getItem(key);
-
-            // If a result was found, parse it from the serialized
-            // string into a JS object. If result isn't truthy, the
-            // key is likely undefined and we'll pass it straight
-            // to the iterator.
-            if (value) {
-                value = dbInfo.serializer.deserialize(value);
-            }
-
-            value = iterator(
-                value,
-                key.substring(keyPrefixLength),
-                iterationNumber++
-            );
-
-            if (value !== void 0) { // eslint-disable-line no-void
-                return value;
-            }
-        }
-    });
-
-    executeCallback(promise, callback);
-    return promise;
-}
-
-// Same as sessionStorage's key() method, except takes a callback.
-function key(n, callback) {
-    const self = this;
-    const promise = self.ready().then(function() {
-        let result;
-        try {
-            result = sessionStorage.key(n);
-        } catch (error) {
-            result = null;
-        }
-
-        // Remove the prefix from the key, if a key is found.
-        if (result) {
-            result = result.substring(dbInfo.keyPrefix.length);
-        }
-
-        return result;
-    });
-
-    executeCallback(promise, callback);
-    return promise;
-}
-
-function keys(callback) {
-    const self = this;
-    const promise = self.ready().then(function() {
-        const length = sessionStorage.length;
-        const keys = [];
-
-        for (let i = 0; i < length; i++) {
-            const itemKey = sessionStorage.key(i);
-            if (itemKey.indexOf(dbInfo.keyPrefix) === 0) {
-                keys.push(itemKey.substring(dbInfo.keyPrefix.length));
-            }
-        }
-        return keys;
-    });
-
-    executeCallback(promise, callback);
-    return promise;
-}
-
-// Supply the number of keys in the datastore to the callback function.
-function length(callback) {
-    const self = this;
-    const promise = self.keys().then(function(keys) {
-        return keys.length;
-    });
-
-    executeCallback(promise, callback);
-    return promise;
-}
-
-// Remove an item from the store, nice and simple.
-function removeItem(key, callback) {
-    key = normalizeKey(key);
-    const promise = this.ready().then(function() {
-        sessionStorage.removeItem(dbInfo.keyPrefix + key);
-    });
-    executeCallback(promise, callback);
-    return promise;
-}
-
-// Set a key's value and run an optional callback once the value is set.
-// Unlike Gaia's implementation, the callback function is passed the value,
-// in case you want to operate on that value only after you're sure it
-// saved, or something like that.
-async function setItem(key, value, callback) {
-    key = normalizeKey(key);
-    await this.ready();
-
-    // Convert undefined values to null.
-    // https://github.com/mozilla/localForage/pull/42
-    value = value ?? null;
-
-    // Save the original value to pass to the callback.
-    const originalValue = value;
-
-    dbInfo.serializer.serialize(value, (value, error) => {
-        if (error) {
-            throw error;
-        } else {
-            try {
-                sessionStorage.setItem(dbInfo.keyPrefix + key, value);
-                executeCallback(Promise.resolve(originalValue), callback);
-            } catch (e) {
-                if (
-                    e.name === 'QuotaExceededError' ||
-                    e.name === 'NS_ERROR_DOM_QUOTA_REACHED'
-                ) {
-                    console.error("Your sesionStorage capacity is used up.");
-                    throw e;
-                }
-                throw e;
-            }
-        }
-    });
-
-}
-
-function dropInstance(options, callback) {
-    callback = getCallback.apply(this, arguments);
-
-    options = (typeof options !== 'function' && options) || {};
-    if (!options.name) {
-        const currentConfig = this.config();
-        options.name = options.name || currentConfig.name;
-        options.storeName = options.storeName || currentConfig.storeName;
-    }
-
-    const self = this;
-    let promise;
-    if (!options.name) {
-        promise = Promise.reject(new Error('Invalid arguments'));
-    } else {
-        promise = new Promise(function(resolve) {
-            if (!options.storeName) {
-                resolve(`${options.name}/`);
-            } else {
-                resolve(_getKeyPrefix(options, self._defaultConfig));
-            }
-        }).then(function(keyPrefix) {
-            for (let i = sessionStorage.length - 1; i >= 0; i--) {
-                const key = sessionStorage.key(i);
-                if (key.indexOf(keyPrefix) === 0) {
-                    sessionStorage.removeItem(key);
-                }
-            }
-        });
-    }
-
-    executeCallback(promise, callback);
-    return promise;
-}
-
-const sessionStorageWrapper = {
-    _driver: 'sessionStorageWrapper',
-    _initStorage: _initStorage,
-    _support: isSessionStorageValid(),
-    iterate: iterate,
-    getItem: getItem,
-    setItem: setItem,
-    removeItem: removeItem,
-    clear: clear,
-    length: length,
-    key: key,
-    keys: keys,
-    dropInstance: dropInstance
-};
-
-export default sessionStorageWrapper;