@aws-amplify/core 6.0.1-api-v6-models.8035dfc.0 → 6.0.1-api-v6-models.572a7b5.0

package/lib/Cache/{AsyncStorageCache.js → StorageCacheCommon.js}

@@ -1,21 +1,17 @@
 "use strict";
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
     };
-})();
+    return __assign.apply(this, arguments);
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -52,117 +48,325 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Cache = exports.AsyncStorage = exports.AsyncStorageCache = void 0;
-var react_native_1 = require("@aws-amplify/react-native");
+exports.StorageCacheCommon = void 0;
 var Logger_1 = require("../Logger");
-var StorageCache_1 = require("./StorageCache");
-var Utils_1 = require("./Utils");
-var CacheUtils_1 = require("./Utils/CacheUtils");
-var errorHelpers_1 = require("./Utils/errorHelpers");
-var logger = new Logger_1.ConsoleLogger('AsyncStorageCache');
-var AsyncStorage = (0, react_native_1.loadAsyncStorage)();
-exports.AsyncStorage = AsyncStorage;
-/*
- * Customized cache which based on the AsyncStorage with LRU implemented
+var constants_1 = require("./constants");
+var utils_1 = require("./utils");
+var errorHelpers_1 = require("./utils/errorHelpers");
+var logger = new Logger_1.ConsoleLogger('StorageCache');
+/**
+ * Initialization of the cache
+ *
  */
-var AsyncStorageCache = /** @class */ (function (_super) {
-    __extends(AsyncStorageCache, _super);
+var StorageCacheCommon = /** @class */ (function () {
     /**
-     * initialize the cache
+     * Initialize the cache
      *
-     * @param {Object} config - the configuration of the cache
+     * @param config - Custom configuration for this instance.
      */
-    function AsyncStorageCache(config) {
-        var _this = _super.call(this, config) || this;
-        _this.getItem = _this.getItem.bind(_this);
-        _this.setItem = _this.setItem.bind(_this);
-        _this.removeItem = _this.removeItem.bind(_this);
-        logger.debug('Using AsyncStorageCache');
-        return _this;
+    function StorageCacheCommon(_a) {
+        var config = _a.config, keyValueStorage = _a.keyValueStorage;
+        this.config = __assign(__assign({}, constants_1.defaultConfig), config);
+        this.keyValueStorage = keyValueStorage;
+        this.sanitizeConfig();
     }
+    StorageCacheCommon.prototype.getModuleName = function () {
+        return 'Cache';
+    };
     /**
-     * decrease current size of the cache
-     * @private
-     * @param amount - the amount of the cache size which needs to be decreased
+     * Set custom configuration for the cache instance.
+     *
+     * @param config - customized configuration (without keyPrefix, which can't be changed)
+     *
+     * @return - the current configuration
      */
-    AsyncStorageCache.prototype._decreaseCurSizeInBytes = function (amount) {
+    StorageCacheCommon.prototype.configure = function (config) {
+        if (config) {
+            if (config.keyPrefix) {
+                logger.warn('keyPrefix can not be re-configured on an existing Cache instance.');
+            }
+            this.config = __assign(__assign({}, this.config), config);
+        }
+        this.sanitizeConfig();
+        return this.config;
+    };
+    /**
+     * return the current size of the cache
+     * @return {Promise}
+     */
+    StorageCacheCommon.prototype.getCurrentCacheSize = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var curSize;
+            var size;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.getCacheCurSize()];
+                    case 0: return [4 /*yield*/, this.getStorage().getItem((0, utils_1.getCurrentSizeKey)(this.config.keyPrefix))];
                     case 1:
-                        curSize = _a.sent();
-                        return [4 /*yield*/, AsyncStorage.setItem((0, CacheUtils_1.getCurrSizeKey)(this.cacheConfig.keyPrefix), (curSize - amount).toString())];
+                        size = _a.sent();
+                        if (!!size) return [3 /*break*/, 3];
+                        return [4 /*yield*/, this.getStorage().setItem((0, utils_1.getCurrentSizeKey)(this.config.keyPrefix), '0')];
                     case 2:
                         _a.sent();
-                        return [2 /*return*/];
+                        size = '0';
+                        _a.label = 3;
+                    case 3: return [2 /*return*/, Number(size)];
                 }
             });
         });
     };
     /**
-     * increase current size of the cache
-     * @private
-     * @param amount - the amount of the cache szie which need to be increased
+     * Set item into cache. You can put number, string, boolean or object.
+     * The cache will first check whether has the same key.
+     * If it has, it will delete the old item and then put the new item in
+     * The cache will pop out items if it is full
+     * You can specify the cache item options. The cache will abort and output a warning:
+     * If the key is invalid
+     * If the size of the item exceeds itemMaxSize.
+     * If the value is undefined
+     * If incorrect cache item configuration
+     * If error happened with browser storage
+     *
+     * @param {String} key - the key of the item
+     * @param {Object} value - the value of the item
+     * @param {Object} [options] - optional, the specified meta-data
+     *
+     * @return {Promise}
      */
-    AsyncStorageCache.prototype._increaseCurSizeInBytes = function (amount) {
+    StorageCacheCommon.prototype.setItem = function (key, value, options) {
         return __awaiter(this, void 0, void 0, function () {
-            var curSize;
+            var cacheItemOptions, prefixedKey, item, val, validKeys, sizeToPop, e_1;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.getCacheCurSize()];
+                    case 0:
+                        logger.debug("Set item: key is ".concat(key, ", value is ").concat(value, " with options: ").concat(options));
+                        if (!key || key === constants_1.currentSizeKey) {
+                            logger.warn("Invalid key: should not be empty or reserved key: '".concat(constants_1.currentSizeKey, "'"));
+                            return [2 /*return*/];
+                        }
+                        if (typeof value === 'undefined') {
+                            logger.warn("The value of item should not be undefined!");
+                            return [2 /*return*/];
+                        }
+                        cacheItemOptions = {
+                            priority: (options === null || options === void 0 ? void 0 : options.priority) !== undefined
+                                ? options.priority
+                                : this.config.defaultPriority,
+                            expires: (options === null || options === void 0 ? void 0 : options.expires) !== undefined
+                                ? options.expires
+                                : this.config.defaultTTL + (0, utils_1.getCurrentTime)(),
+                        };
+                        if (cacheItemOptions.priority < 1 || cacheItemOptions.priority > 5) {
+                            logger.warn("Invalid parameter: priority due to out or range. It should be within 1 and 5.");
+                            return [2 /*return*/];
+                        }
+                        prefixedKey = "".concat(this.config.keyPrefix).concat(key);
+                        item = this.fillCacheItem(prefixedKey, value, cacheItemOptions);
+                        // check whether this item is too big;
+                        if (item.byteSize > this.config.itemMaxSize) {
+                            logger.warn("Item with key: ".concat(key, " you are trying to put into is too big!"));
+                            return [2 /*return*/];
+                        }
+                        _a.label = 1;
                     case 1:
-                        curSize = _a.sent();
-                        return [4 /*yield*/, AsyncStorage.setItem((0, CacheUtils_1.getCurrSizeKey)(this.cacheConfig.keyPrefix), (curSize + amount).toString())];
+                        _a.trys.push([1, 11, , 12]);
+                        return [4 /*yield*/, this.getStorage().getItem(prefixedKey)];
                     case 2:
+                        val = _a.sent();
+                        if (!val) return [3 /*break*/, 4];
+                        return [4 /*yield*/, this.removeCacheItem(prefixedKey, JSON.parse(val).byteSize)];
+                    case 3:
                         _a.sent();
-                        return [2 /*return*/];
+                        _a.label = 4;
+                    case 4: return [4 /*yield*/, this.isCacheFull(item.byteSize)];
+                    case 5:
+                        if (!_a.sent()) return [3 /*break*/, 10];
+                        return [4 /*yield*/, this.clearInvalidAndGetRemainingKeys()];
+                    case 6:
+                        validKeys = _a.sent();
+                        return [4 /*yield*/, this.isCacheFull(item.byteSize)];
+                    case 7:
+                        if (!_a.sent()) return [3 /*break*/, 10];
+                        return [4 /*yield*/, this.sizeToPop(item.byteSize)];
+                    case 8:
+                        sizeToPop = _a.sent();
+                        return [4 /*yield*/, this.popOutItems(validKeys, sizeToPop)];
+                    case 9:
+                        _a.sent();
+                        _a.label = 10;
+                    case 10: 
+                    // put item in the cache
+                    return [2 /*return*/, this.setCacheItem(prefixedKey, item)];
+                    case 11:
+                        e_1 = _a.sent();
+                        logger.warn("setItem failed! ".concat(e_1));
+                        return [3 /*break*/, 12];
+                    case 12: return [2 /*return*/];
                 }
             });
         });
     };
     /**
-     * update the visited time if item has been visited
-     * @private
-     * @param item - the item which need to be refreshed
-     * @param prefixedKey - the key of the item
+     * Get item from cache. It will return null if item doesn’t exist or it has been expired.
+     * If you specified callback function in the options,
+     * then the function will be executed if no such item in the cache
+     * and finally put the return value into cache.
+     * Please make sure the callback function will return the value you want to put into the cache.
+     * The cache will abort output a warning:
+     * If the key is invalid
+     * If error happened with AsyncStorage
+     *
+     * @param {String} key - the key of the item
+     * @param {Object} [options] - the options of callback function
      *
-     * @return the refreshed item
+     * @return {Promise} - return a promise resolves to be the value of the item
      */
-    AsyncStorageCache.prototype._refreshItem = function (item, prefixedKey) {
+    StorageCacheCommon.prototype.getItem = function (key, options) {
         return __awaiter(this, void 0, void 0, function () {
+            var cached, prefixedKey, item, val, e_2;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        item.visitedTime = (0, Utils_1.getCurrTime)();
-                        return [4 /*yield*/, AsyncStorage.setItem(prefixedKey, JSON.stringify(item))];
+                        logger.debug("Get item: key is ".concat(key, " with options ").concat(options));
+                        if (!key || key === constants_1.currentSizeKey) {
+                            logger.warn("Invalid key: should not be empty or reserved key: '".concat(constants_1.currentSizeKey, "'"));
+                            return [2 /*return*/, null];
+                        }
+                        prefixedKey = "".concat(this.config.keyPrefix).concat(key);
+                        _a.label = 1;
                     case 1:
+                        _a.trys.push([1, 11, , 12]);
+                        return [4 /*yield*/, this.getStorage().getItem(prefixedKey)];
+                    case 2:
+                        cached = _a.sent();
+                        if (!(cached != null)) return [3 /*break*/, 7];
+                        return [4 /*yield*/, this.isExpired(prefixedKey)];
+                    case 3:
+                        if (!_a.sent()) return [3 /*break*/, 5];
+                        // if expired, remove that item and return null
+                        return [4 /*yield*/, this.removeCacheItem(prefixedKey, JSON.parse(cached).byteSize)];
+                    case 4:
+                        // if expired, remove that item and return null
                         _a.sent();
-                        return [2 /*return*/, item];
+                        return [3 /*break*/, 7];
+                    case 5: return [4 /*yield*/, this.updateVisitedTime(JSON.parse(cached), prefixedKey)];
+                    case 6:
+                        item = _a.sent();
+                        return [2 /*return*/, item.data];
+                    case 7:
+                        if (!(options === null || options === void 0 ? void 0 : options.callback)) return [3 /*break*/, 10];
+                        val = options.callback();
+                        if (!(val !== null)) return [3 /*break*/, 9];
+                        return [4 /*yield*/, this.setItem(key, val, options)];
+                    case 8:
+                        _a.sent();
+                        _a.label = 9;
+                    case 9: return [2 /*return*/, val];
+                    case 10: return [2 /*return*/, null];
+                    case 11:
+                        e_2 = _a.sent();
+                        logger.warn("getItem failed! ".concat(e_2));
+                        return [2 /*return*/, null];
+                    case 12: return [2 /*return*/];
                 }
             });
         });
     };
     /**
-     * check wether item is expired
-     * @private
+     * remove item from the cache
+     * The cache will abort output a warning:
+     * If error happened with AsyncStorage
+     * @param {String} key - the key of the item
+     * @return {Promise}
+     */
+    StorageCacheCommon.prototype.removeItem = function (key) {
+        return __awaiter(this, void 0, void 0, function () {
+            var prefixedKey, val, e_3;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        logger.debug("Remove item: key is ".concat(key));
+                        if (!key || key === constants_1.currentSizeKey) {
+                            logger.warn("Invalid key: should not be empty or reserved key: '".concat(constants_1.currentSizeKey, "'"));
+                            return [2 /*return*/];
+                        }
+                        prefixedKey = "".concat(this.config.keyPrefix).concat(key);
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 5, , 6]);
+                        return [4 /*yield*/, this.getStorage().getItem(prefixedKey)];
+                    case 2:
+                        val = _a.sent();
+                        if (!val) return [3 /*break*/, 4];
+                        return [4 /*yield*/, this.removeCacheItem(prefixedKey, JSON.parse(val).byteSize)];
+                    case 3:
+                        _a.sent();
+                        _a.label = 4;
+                    case 4: return [3 /*break*/, 6];
+                    case 5:
+                        e_3 = _a.sent();
+                        logger.warn("removeItem failed! ".concat(e_3));
+                        return [3 /*break*/, 6];
+                    case 6: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Return all the keys owned by this cache.
+     * Will return an empty array if error occurred.
+     *
+     * @return {Promise}
+     */
+    StorageCacheCommon.prototype.getAllKeys = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var e_4;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        return [4 /*yield*/, this.getAllCacheKeys()];
+                    case 1: return [2 /*return*/, _a.sent()];
+                    case 2:
+                        e_4 = _a.sent();
+                        logger.warn("getAllkeys failed! ".concat(e_4));
+                        return [2 /*return*/, []];
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    StorageCacheCommon.prototype.getStorage = function () {
+        return this.keyValueStorage;
+    };
+    /**
+     * check whether item is expired
+     *
      * @param key - the key of the item
      *
      * @return true if the item is expired.
      */
-    AsyncStorageCache.prototype._isExpired = function (key) {
+    StorageCacheCommon.prototype.isExpired = function (key) {
         return __awaiter(this, void 0, void 0, function () {
             var text, item;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, AsyncStorage.getItem(key)];
+                    case 0: return [4 /*yield*/, this.getStorage().getItem(key)];
                     case 1:
                         text = _a.sent();
                         (0, errorHelpers_1.assert)(text !== null, errorHelpers_1.CacheErrorCode.NoCacheItem, "Key: ".concat(key));
                         item = JSON.parse(text);
-                        if ((0, Utils_1.getCurrTime)() >= item.expires) {
+                        if ((0, utils_1.getCurrentTime)() >= item.expires) {
                             return [2 /*return*/, true];
                         }
                         return [2 /*return*/, false];
@@ -172,36 +376,36 @@ var AsyncStorageCache = /** @class */ (function (_super) {
     };
     /**
      * delete item from cache
-     * @private
+     *
      * @param prefixedKey - the key of the item
      * @param size - optional, the byte size of the item
      */
-    AsyncStorageCache.prototype._removeItem = function (prefixedKey, size) {
+    StorageCacheCommon.prototype.removeCacheItem = function (prefixedKey, size) {
         return __awaiter(this, void 0, void 0, function () {
-            var config, itemSize, removeItemError_1;
+            var item, itemSize, removeItemError_1;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, AsyncStorage.getItem(prefixedKey)];
+                    case 0: return [4 /*yield*/, this.getStorage().getItem(prefixedKey)];
                     case 1:
-                        config = _a.sent();
-                        (0, errorHelpers_1.assert)(!!config, errorHelpers_1.CacheErrorCode.NoCacheItem, "Key: ".concat(prefixedKey));
-                        itemSize = size !== null && size !== void 0 ? size : JSON.parse(config).byteSize;
+                        item = _a.sent();
+                        (0, errorHelpers_1.assert)(item !== null, errorHelpers_1.CacheErrorCode.NoCacheItem, "Key: ".concat(prefixedKey));
+                        itemSize = size !== null && size !== void 0 ? size : JSON.parse(item).byteSize;
                         // first try to update the current size of the cache
-                        return [4 /*yield*/, this._decreaseCurSizeInBytes(itemSize)];
+                        return [4 /*yield*/, this.decreaseCurrentSizeInBytes(itemSize)];
                     case 2:
                         // first try to update the current size of the cache
                         _a.sent();
                         _a.label = 3;
                     case 3:
                         _a.trys.push([3, 5, , 7]);
-                        return [4 /*yield*/, AsyncStorage.removeItem(prefixedKey)];
+                        return [4 /*yield*/, this.getStorage().removeItem(prefixedKey)];
                     case 4:
                         _a.sent();
                         return [3 /*break*/, 7];
                     case 5:
                         removeItemError_1 = _a.sent();
                         // if some error happened, we need to rollback the current size
-                        return [4 /*yield*/, this._increaseCurSizeInBytes(itemSize)];
+                        return [4 /*yield*/, this.increaseCurrentSizeInBytes(itemSize)];
                     case 6:
                         // if some error happened, we need to rollback the current size
                         _a.sent();
@@ -212,35 +416,145 @@ var AsyncStorageCache = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * produce a JSON object with meta-data and data value
+     * @param value - the value of the item
+     * @param options - optional, the specified meta-data
+     *
+     * @return - the item which has the meta-data and the value
+     */
+    StorageCacheCommon.prototype.fillCacheItem = function (key, value, options) {
+        var _a, _b;
+        var item = {
+            key: key,
+            data: value,
+            timestamp: (0, utils_1.getCurrentTime)(),
+            visitedTime: (0, utils_1.getCurrentTime)(),
+            priority: (_a = options.priority) !== null && _a !== void 0 ? _a : 0,
+            expires: (_b = options.expires) !== null && _b !== void 0 ? _b : 0,
+            type: typeof value,
+            byteSize: 0,
+        };
+        // calculate byte size
+        item.byteSize = (0, utils_1.getByteLength)(JSON.stringify(item));
+        // re-calculate using cache item with updated byteSize property
+        item.byteSize = (0, utils_1.getByteLength)(JSON.stringify(item));
+        return item;
+    };
+    StorageCacheCommon.prototype.sanitizeConfig = function () {
+        if (this.config.itemMaxSize > this.config.capacityInBytes) {
+            logger.error('Invalid parameter: itemMaxSize. It should be smaller than capacityInBytes. Setting back to default.');
+            this.config.itemMaxSize = constants_1.defaultConfig.itemMaxSize;
+        }
+        if (this.config.defaultPriority > 5 || this.config.defaultPriority < 1) {
+            logger.error('Invalid parameter: defaultPriority. It should be between 1 and 5. Setting back to default.');
+            this.config.defaultPriority = constants_1.defaultConfig.defaultPriority;
+        }
+        if (Number(this.config.warningThreshold) > 1 ||
+            Number(this.config.warningThreshold) < 0) {
+            logger.error('Invalid parameter: warningThreshold. It should be between 0 and 1. Setting back to default.');
+            this.config.warningThreshold = constants_1.defaultConfig.warningThreshold;
+        }
+        // Set 5MB limit
+        var cacheLimit = 5 * 1024 * 1024;
+        if (this.config.capacityInBytes > cacheLimit) {
+            logger.error('Cache Capacity should be less than 5MB. Setting back to default. Setting back to default.');
+            this.config.capacityInBytes = constants_1.defaultConfig.capacityInBytes;
+        }
+    };
+    /**
+     * increase current size of the cache
+     *
+     * @param amount - the amount of the cache szie which need to be increased
+     */
+    StorageCacheCommon.prototype.increaseCurrentSizeInBytes = function (amount) {
+        return __awaiter(this, void 0, void 0, function () {
+            var size;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getCurrentCacheSize()];
+                    case 1:
+                        size = _a.sent();
+                        return [4 /*yield*/, this.getStorage().setItem((0, utils_1.getCurrentSizeKey)(this.config.keyPrefix), (size + amount).toString())];
+                    case 2:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * decrease current size of the cache
+     *
+     * @param amount - the amount of the cache size which needs to be decreased
+     */
+    StorageCacheCommon.prototype.decreaseCurrentSizeInBytes = function (amount) {
+        return __awaiter(this, void 0, void 0, function () {
+            var size;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getCurrentCacheSize()];
+                    case 1:
+                        size = _a.sent();
+                        return [4 /*yield*/, this.getStorage().setItem((0, utils_1.getCurrentSizeKey)(this.config.keyPrefix), (size - amount).toString())];
+                    case 2:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * update the visited time if item has been visited
+     *
+     * @param item - the item which need to be updated
+     * @param prefixedKey - the key of the item
+     *
+     * @return the updated item
+     */
+    StorageCacheCommon.prototype.updateVisitedTime = function (item, prefixedKey) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        item.visitedTime = (0, utils_1.getCurrentTime)();
+                        return [4 /*yield*/, this.getStorage().setItem(prefixedKey, JSON.stringify(item))];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/, item];
+                }
+            });
+        });
+    };
     /**
      * put item into cache
-     * @private
+     *
      * @param prefixedKey - the key of the item
      * @param itemData - the value of the item
      * @param itemSizeInBytes - the byte size of the item
      */
-    AsyncStorageCache.prototype._setItem = function (prefixedKey, item) {
+    StorageCacheCommon.prototype.setCacheItem = function (prefixedKey, item) {
         return __awaiter(this, void 0, void 0, function () {
             var setItemErr_1;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0: 
                     // first try to update the current size of the cache.
-                    return [4 /*yield*/, this._increaseCurSizeInBytes(item.byteSize)];
+                    return [4 /*yield*/, this.increaseCurrentSizeInBytes(item.byteSize)];
                     case 1:
                         // first try to update the current size of the cache.
                         _a.sent();
                         _a.label = 2;
                     case 2:
                         _a.trys.push([2, 4, , 6]);
-                        return [4 /*yield*/, AsyncStorage.setItem(prefixedKey, JSON.stringify(item))];
+                        return [4 /*yield*/, this.getStorage().setItem(prefixedKey, JSON.stringify(item))];
                     case 3:
                         _a.sent();
                         return [3 /*break*/, 6];
                     case 4:
                         setItemErr_1 = _a.sent();
                         // if some error happened, we need to rollback the current size
-                        return [4 /*yield*/, this._decreaseCurSizeInBytes(item.byteSize)];
+                        return [4 /*yield*/, this.decreaseCurrentSizeInBytes(item.byteSize)];
                     case 5:
                         // if some error happened, we need to rollback the current size
                         _a.sent();
@@ -253,23 +567,21 @@ var AsyncStorageCache = /** @class */ (function (_super) {
     };
     /**
      * total space needed when poping out items
-     * @private
+     *
      * @param itemSize
      *
      * @return total space needed
      */
-    AsyncStorageCache.prototype._sizeToPop = function (itemSize) {
+    StorageCacheCommon.prototype.sizeToPop = function (itemSize) {
         return __awaiter(this, void 0, void 0, function () {
-            var spaceItemNeed, cacheThresholdSpace;
+            var cur, spaceItemNeed, cacheThresholdSpace;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.getCacheCurSize()];
+                    case 0: return [4 /*yield*/, this.getCurrentCacheSize()];
                     case 1:
-                        spaceItemNeed = (_a.sent()) +
-                            itemSize -
-                            this.cacheConfig.capacityInBytes;
-                        cacheThresholdSpace = (1 - this.cacheConfig.warningThreshold) *
-                            this.cacheConfig.capacityInBytes;
+                        cur = _a.sent();
+                        spaceItemNeed = cur + itemSize - this.config.capacityInBytes;
+                        cacheThresholdSpace = (1 - this.config.warningThreshold) * this.config.capacityInBytes;
                         return [2 /*return*/, spaceItemNeed > cacheThresholdSpace
                                 ? spaceItemNeed
                                 : cacheThresholdSpace];
@@ -279,63 +591,20 @@ var AsyncStorageCache = /** @class */ (function (_super) {
     };
     /**
      * see whether cache is full
-     * @private
+     *
      * @param itemSize
      *
      * @return true if cache is full
      */
-    AsyncStorageCache.prototype._isCacheFull = function (itemSize) {
+    StorageCacheCommon.prototype.isCacheFull = function (itemSize) {
         return __awaiter(this, void 0, void 0, function () {
-            var _a;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        _a = itemSize;
-                        return [4 /*yield*/, this.getCacheCurSize()];
-                    case 1: return [2 /*return*/, (_a + (_b.sent()) >
-                            this.cacheConfig.capacityInBytes)];
-                }
-            });
-        });
-    };
-    /**
-     * scan the storage and find out all the keys owned by this cache
-     * also clean the expired keys while scanning
-     * @private
-     * @return array of keys
-     */
-    AsyncStorageCache.prototype._findValidKeys = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            var keys, keyInCache, i, key;
+            var cur;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0:
-                        keys = [];
-                        keyInCache = [];
-                        return [4 /*yield*/, AsyncStorage.getAllKeys()];
+                    case 0: return [4 /*yield*/, this.getCurrentCacheSize()];
                     case 1:
-                        keyInCache = _a.sent();
-                        i = 0;
-                        _a.label = 2;
-                    case 2:
-                        if (!(i < keyInCache.length)) return [3 /*break*/, 7];
-                        key = keyInCache[i];
-                        if (!(key.indexOf(this.cacheConfig.keyPrefix) === 0 &&
-                            key !== (0, CacheUtils_1.getCurrSizeKey)(this.cacheConfig.keyPrefix))) return [3 /*break*/, 6];
-                        return [4 /*yield*/, this._isExpired(key)];
-                    case 3:
-                        if (!_a.sent()) return [3 /*break*/, 5];
-                        return [4 /*yield*/, this._removeItem(key)];
-                    case 4:
-                        _a.sent();
-                        return [3 /*break*/, 6];
-                    case 5:
-                        keys.push(key);
-                        _a.label = 6;
-                    case 6:
-                        i += 1;
-                        return [3 /*break*/, 2];
-                    case 7: return [2 /*return*/, keys];
+                        cur = _a.sent();
+                        return [2 /*return*/, itemSize + cur > this.config.capacityInBytes];
                 }
             });
         });
@@ -348,7 +617,7 @@ var AsyncStorageCache = /** @class */ (function (_super) {
      * @param keys - all the keys in this cache
      * @param sizeToPop - the total size of the items which needed to be poped out
      */
-    AsyncStorageCache.prototype._popOutItems = function (keys, sizeToPop) {
+    StorageCacheCommon.prototype.popOutItems = function (keys, sizeToPop) {
         return __awaiter(this, void 0, void 0, function () {
             var items, remainedSize, i, val, item, i;
             return __generator(this, function (_a) {
@@ -360,7 +629,7 @@ var AsyncStorageCache = /** @class */ (function (_super) {
                         _a.label = 1;
                     case 1:
                         if (!(i < keys.length)) return [3 /*break*/, 4];
-                        return [4 /*yield*/, AsyncStorage.getItem(keys[i])];
+                        return [4 /*yield*/, this.getStorage().getItem(keys[i])];
                     case 2:
                         val = _a.sent();
                         if (val != null) {
@@ -394,7 +663,7 @@ var AsyncStorageCache = /** @class */ (function (_super) {
                     case 5:
                         if (!(i < items.length)) return [3 /*break*/, 8];
                         // pop out items until we have enough room for new item
-                        return [4 /*yield*/, this._removeItem(items[i].key, items[i].byteSize)];
+                        return [4 /*yield*/, this.removeCacheItem(items[i].key, items[i].byteSize)];
                     case 6:
                         // pop out items until we have enough room for new item
                         _a.sent();
@@ -412,324 +681,117 @@ var AsyncStorageCache = /** @class */ (function (_super) {
         });
     };
     /**
-     * Set item into cache. You can put number, string, boolean or object.
-     * The cache will first check whether has the same key.
-     * If it has, it will delete the old item and then put the new item in
-     * The cache will pop out items if it is full
-     * You can specify the cache item options. The cache will abort and output a warning:
-     * If the key is invalid
-     * If the size of the item exceeds itemMaxSize.
-     * If the value is undefined
-     * If incorrect cache item configuration
-     * If error happened with browser storage
+     * Scan the storage and combine the following operations for efficiency
+     *   1. Clear out all expired keys owned by this cache, not including the size key.
+     *   2. Return the remaining keys.
      *
-     * @param {String} key - the key of the item
-     * @param {Object} value - the value of the item
-     * @param {Object} [options] - optional, the specified meta-data
-     * @return {Promise}
+     * @return The remaining valid keys
      */
-    AsyncStorageCache.prototype.setItem = function (key, value, options) {
+    StorageCacheCommon.prototype.clearInvalidAndGetRemainingKeys = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var prefixedKey, cacheItemOptions, item, val, validKeys, sizeToPop, e_1;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        logger.debug("Set item: key is ".concat(key, ", value is ").concat(value, " with options: ").concat(options));
-                        prefixedKey = this.cacheConfig.keyPrefix + key;
-                        // invalid keys
-                        if (prefixedKey === this.cacheConfig.keyPrefix ||
-                            prefixedKey === (0, CacheUtils_1.getCurrSizeKey)(this.cacheConfig.keyPrefix)) {
-                            logger.warn("Invalid key: should not be empty or 'CurSize'");
-                            return [2 /*return*/];
-                        }
-                        if (typeof value === 'undefined') {
-                            logger.warn("The value of item should not be undefined!");
-                            return [2 /*return*/];
-                        }
-                        cacheItemOptions = {
-                            priority: options && options.priority !== undefined
-                                ? options.priority
-                                : this.cacheConfig.defaultPriority,
-                            expires: options && options.expires !== undefined
-                                ? options.expires
-                                : this.cacheConfig.defaultTTL + (0, Utils_1.getCurrTime)(),
-                        };
-                        if (cacheItemOptions.priority < 1 || cacheItemOptions.priority > 5) {
-                            logger.warn("Invalid parameter: priority due to out or range. It should be within 1 and 5.");
-                            return [2 /*return*/];
-                        }
-                        item = this.fillCacheItem(prefixedKey, value, cacheItemOptions);
-                        // check wether this item is too big;
-                        if (item.byteSize > this.cacheConfig.itemMaxSize) {
-                            logger.warn("Item with key: ".concat(key, " you are trying to put into is too big!"));
-                            return [2 /*return*/];
-                        }
-                        _a.label = 1;
-                    case 1:
-                        _a.trys.push([1, 12, , 13]);
-                        return [4 /*yield*/, AsyncStorage.getItem(prefixedKey)];
-                    case 2:
-                        val = _a.sent();
-                        if (!val) return [3 /*break*/, 4];
-                        return [4 /*yield*/, this._removeItem(prefixedKey, JSON.parse(val).byteSize)];
-                    case 3:
-                        _a.sent();
-                        _a.label = 4;
-                    case 4: return [4 /*yield*/, this._isCacheFull(item.byteSize)];
-                    case 5:
-                        if (!_a.sent()) return [3 /*break*/, 10];
-                        return [4 /*yield*/, this._findValidKeys()];
-                    case 6:
-                        validKeys = _a.sent();
-                        return [4 /*yield*/, this._isCacheFull(item.byteSize)];
-                    case 7:
-                        if (!_a.sent()) return [3 /*break*/, 10];
-                        return [4 /*yield*/, this._sizeToPop(item.byteSize)];
-                    case 8:
-                        sizeToPop = _a.sent();
-                        return [4 /*yield*/, this._popOutItems(validKeys, sizeToPop)];
-                    case 9:
-                        _a.sent();
-                        _a.label = 10;
-                    case 10: 
-                    // put item in the cache
-                    return [4 /*yield*/, this._setItem(prefixedKey, item)];
-                    case 11:
-                        // put item in the cache
-                        _a.sent();
-                        return [3 /*break*/, 13];
-                    case 12:
-                        e_1 = _a.sent();
-                        logger.warn("setItem failed! ".concat(e_1));
-                        return [3 /*break*/, 13];
-                    case 13: return [2 /*return*/];
-                }
-            });
-        });
-    };
-    /**
-     * Get item from cache. It will return null if item doesn’t exist or it has been expired.
-     * If you specified callback function in the options,
-     * then the function will be executed if no such item in the cache
-     * and finally put the return value into cache.
-     * Please make sure the callback function will return the value you want to put into the cache.
-     * The cache will abort output a warning:
-     * If the key is invalid
-     * If error happened with AsyncStorage
-     *
-     * @param {String} key - the key of the item
-     * @param {Object} [options] - the options of callback function
-     * @return {Promise} - return a promise resolves to be the value of the item
-     */
-    AsyncStorageCache.prototype.getItem = function (key, options) {
-        return __awaiter(this, void 0, void 0, function () {
-            var ret, prefixedKey, item, val, e_2;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var remainingKeys, keys, keys_1, keys_1_1, key, e_5_1;
+            var e_5, _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
-                        logger.debug("Get item: key is ".concat(key, " with options ").concat(options));
-                        ret = null;
-                        prefixedKey = this.cacheConfig.keyPrefix + key;
-                        if (prefixedKey === this.cacheConfig.keyPrefix ||
-                            prefixedKey === (0, CacheUtils_1.getCurrSizeKey)(this.cacheConfig.keyPrefix)) {
-                            logger.warn("Invalid key: should not be empty or 'CurSize'");
-                            return [2 /*return*/, null];
-                        }
-                        _a.label = 1;
+                        remainingKeys = [];
+                        return [4 /*yield*/, this.getAllCacheKeys({
+                                omitSizeKey: true,
+                            })];
                     case 1:
-                        _a.trys.push([1, 8, , 9]);
-                        return [4 /*yield*/, AsyncStorage.getItem(prefixedKey)];
+                        keys = _b.sent();
+                        _b.label = 2;
                     case 2:
-                        ret = _a.sent();
-                        if (!(ret != null)) return [3 /*break*/, 7];
-                        return [4 /*yield*/, this._isExpired(prefixedKey)];
+                        _b.trys.push([2, 9, 10, 11]);
+                        keys_1 = __values(keys), keys_1_1 = keys_1.next();
+                        _b.label = 3;
                     case 3:
-                        if (!_a.sent()) return [3 /*break*/, 5];
-                        // if expired, remove that item and return null
-                        return [4 /*yield*/, this._removeItem(prefixedKey, JSON.parse(ret).byteSize)];
+                        if (!!keys_1_1.done) return [3 /*break*/, 8];
+                        key = keys_1_1.value;
+                        return [4 /*yield*/, this.isExpired(key)];
                     case 4:
-                        // if expired, remove that item and return null
-                        _a.sent();
-                        return [3 /*break*/, 7];
+                        if (!_b.sent()) return [3 /*break*/, 6];
+                        return [4 /*yield*/, this.removeCacheItem(key)];
                     case 5:
-                        item = JSON.parse(ret);
-                        return [4 /*yield*/, this._refreshItem(item, prefixedKey)];
+                        _b.sent();
+                        return [3 /*break*/, 7];
                     case 6:
-                        item = _a.sent();
-                        return [2 /*return*/, item.data];
+                        remainingKeys.push(key);
+                        _b.label = 7;
                     case 7:
-                        if (options && options.callback !== undefined) {
-                            val = options.callback();
-                            if (val !== null) {
-                                this.setItem(key, val, options);
-                            }
-                            return [2 /*return*/, val];
-                        }
-                        return [2 /*return*/, null];
-                    case 8:
-                        e_2 = _a.sent();
-                        logger.warn("getItem failed! ".concat(e_2));
-                        return [2 /*return*/, null];
-                    case 9: return [2 /*return*/];
-                }
-            });
-        });
-    };
-    /**
-     * remove item from the cache
-     * The cache will abort output a warning:
-     * If error happened with AsyncStorage
-     * @param {String} key - the key of the item
-     * @return {Promise}
-     */
-    AsyncStorageCache.prototype.removeItem = function (key) {
-        return __awaiter(this, void 0, void 0, function () {
-            var prefixedKey, val, e_3;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        logger.debug("Remove item: key is ".concat(key));
-                        prefixedKey = this.cacheConfig.keyPrefix + key;
-                        if (prefixedKey === this.cacheConfig.keyPrefix ||
-                            prefixedKey === (0, CacheUtils_1.getCurrSizeKey)(this.cacheConfig.keyPrefix)) {
-                            return [2 /*return*/];
+                        keys_1_1 = keys_1.next();
+                        return [3 /*break*/, 3];
+                    case 8: return [3 /*break*/, 11];
+                    case 9:
+                        e_5_1 = _b.sent();
+                        e_5 = { error: e_5_1 };
+                        return [3 /*break*/, 11];
+                    case 10:
+                        try {
+                            if (keys_1_1 && !keys_1_1.done && (_a = keys_1.return)) _a.call(keys_1);
                         }
-                        _a.label = 1;
-                    case 1:
-                        _a.trys.push([1, 5, , 6]);
-                        return [4 /*yield*/, AsyncStorage.getItem(prefixedKey)];
-                    case 2:
-                        val = _a.sent();
-                        if (!val) return [3 /*break*/, 4];
-                        return [4 /*yield*/, this._removeItem(prefixedKey, JSON.parse(val).byteSize)];
-                    case 3:
-                        _a.sent();
-                        _a.label = 4;
-                    case 4: return [3 /*break*/, 6];
-                    case 5:
-                        e_3 = _a.sent();
-                        logger.warn("removeItem failed! ".concat(e_3));
-                        return [3 /*break*/, 6];
-                    case 6: return [2 /*return*/];
+                        finally { if (e_5) throw e_5.error; }
+                        return [7 /*endfinally*/];
+                    case 11: return [2 /*return*/, remainingKeys];
                 }
             });
         });
     };
     /**
      * clear the entire cache
-     * The cache will abort output a warning:
-     * If error happened with AsyncStorage
+     * The cache will abort and output a warning if error occurs
      * @return {Promise}
      */
-    AsyncStorageCache.prototype.clear = function () {
+    StorageCacheCommon.prototype.clear = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var keys, keysToRemove, i, i, e_4;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var keys, keys_2, keys_2_1, key, e_6_1, e_7;
+            var e_6, _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
                         logger.debug("Clear Cache");
-                        _a.label = 1;
+                        _b.label = 1;
                     case 1:
-                        _a.trys.push([1, 7, , 8]);
-                        return [4 /*yield*/, AsyncStorage.getAllKeys()];
+                        _b.trys.push([1, 11, , 12]);
+                        return [4 /*yield*/, this.getAllKeys()];
                     case 2:
-                        keys = _a.sent();
-                        keysToRemove = [];
-                        for (i = 0; i < keys.length; i += 1) {
-                            if (keys[i].indexOf(this.cacheConfig.keyPrefix) === 0) {
-                                keysToRemove.push(keys[i]);
-                            }
-                        }
-                        i = 0;
-                        _a.label = 3;
+                        keys = _b.sent();
+                        _b.label = 3;
                     case 3:
-                        if (!(i < keysToRemove.length)) return [3 /*break*/, 6];
-                        return [4 /*yield*/, AsyncStorage.removeItem(keysToRemove[i])];
+                        _b.trys.push([3, 8, 9, 10]);
+                        keys_2 = __values(keys), keys_2_1 = keys_2.next();
+                        _b.label = 4;
                     case 4:
-                        _a.sent();
-                        _a.label = 5;
+                        if (!!keys_2_1.done) return [3 /*break*/, 7];
+                        key = keys_2_1.value;
+                        return [4 /*yield*/, this.getStorage().removeItem(key)];
                     case 5:
-                        i += 1;
-                        return [3 /*break*/, 3];
-                    case 6: return [3 /*break*/, 8];
-                    case 7:
-                        e_4 = _a.sent();
-                        logger.warn("clear failed! ".concat(e_4));
-                        return [3 /*break*/, 8];
-                    case 8: return [2 /*return*/];
-                }
-            });
-        });
-    };
-    /**
-     * return the current size of the cache
-     * @return {Promise}
-     */
-    AsyncStorageCache.prototype.getCacheCurSize = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            var ret;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, AsyncStorage.getItem((0, CacheUtils_1.getCurrSizeKey)(this.cacheConfig.keyPrefix))];
-                    case 1:
-                        ret = _a.sent();
-                        if (!!ret) return [3 /*break*/, 3];
-                        return [4 /*yield*/, AsyncStorage.setItem((0, CacheUtils_1.getCurrSizeKey)(this.cacheConfig.keyPrefix), '0')];
-                    case 2:
-                        _a.sent();
-                        ret = '0';
-                        _a.label = 3;
-                    case 3: return [2 /*return*/, Number(ret)];
-                }
-            });
-        });
-    };
-    /**
-     * Return all the keys in the cache.
-     * Will return an empty array if error happend.
-     * @return {Promise}
-     */
-    AsyncStorageCache.prototype.getAllKeys = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            var keys, retKeys, i, e_5;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        _a.trys.push([0, 2, , 3]);
-                        return [4 /*yield*/, AsyncStorage.getAllKeys()];
-                    case 1:
-                        keys = _a.sent();
-                        retKeys = [];
-                        for (i = 0; i < keys.length; i += 1) {
-                            if (keys[i].indexOf(this.cacheConfig.keyPrefix) === 0 &&
-                                keys[i] !== (0, CacheUtils_1.getCurrSizeKey)(this.cacheConfig.keyPrefix)) {
-                                retKeys.push(keys[i].substring(this.cacheConfig.keyPrefix.length));
-                            }
+                        _b.sent();
+                        _b.label = 6;
+                    case 6:
+                        keys_2_1 = keys_2.next();
+                        return [3 /*break*/, 4];
+                    case 7: return [3 /*break*/, 10];
+                    case 8:
+                        e_6_1 = _b.sent();
+                        e_6 = { error: e_6_1 };
+                        return [3 /*break*/, 10];
+                    case 9:
+                        try {
+                            if (keys_2_1 && !keys_2_1.done && (_a = keys_2.return)) _a.call(keys_2);
                         }
-                        return [2 /*return*/, retKeys];
-                    case 2:
-                        e_5 = _a.sent();
-                        logger.warn("getALlkeys failed! ".concat(e_5));
-                        return [2 /*return*/, []];
-                    case 3: return [2 /*return*/];
+                        finally { if (e_6) throw e_6.error; }
+                        return [7 /*endfinally*/];
+                    case 10: return [3 /*break*/, 12];
+                    case 11:
+                        e_7 = _b.sent();
+                        logger.warn("clear failed! ".concat(e_7));
+                        return [3 /*break*/, 12];
+                    case 12: return [2 /*return*/];
                 }
             });
         });
     };
-    /**
-     * Return a new instance of cache with customized configuration.
-     * @param {Object} config - the customized configuration
-     * @return {Object} - the new instance of Cache
-     */
-    AsyncStorageCache.prototype.createInstance = function (config) {
-        if (config.keyPrefix === Utils_1.defaultConfig.keyPrefix) {
-            logger.error('invalid keyPrefix, setting keyPrefix with timeStamp');
-            config.keyPrefix = Utils_1.getCurrTime.toString();
-        }
-        return new AsyncStorageCache(config);
-    };
-    return AsyncStorageCache;
-}(StorageCache_1.StorageCache));
-exports.AsyncStorageCache = AsyncStorageCache;
-var instance = new AsyncStorageCache();
-exports.Cache = instance;
+    return StorageCacheCommon;
+}());
+exports.StorageCacheCommon = StorageCacheCommon;