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

package/lib/Cache/StorageCache.d.ts

@@ -1,39 +1,22 @@
-import { CacheConfig, CacheItem, CacheItemOptions } from './types';
+import { StorageCacheCommon } from './StorageCacheCommon';
+import { Cache, CacheConfig } from './types';
 /**
- * Initialization of the cache
- *
+ * Customized storage based on the SessionStorage or LocalStorage with LRU implemented
  */
-export declare class StorageCache {
-    private instanceConfig?;
+export declare class StorageCache extends StorageCacheCommon implements Cache {
+    storage: Storage;
     /**
-     * Initialize the cache
-     *
-     * @param config - Custom configuration for this instance.
+     * initialize the cache
+     * @param config - the configuration of the cache
      */
     constructor(config?: CacheConfig);
-    getModuleName(): string;
-    private sanitizeConfig;
+    protected getAllCacheKeys(options?: {
+        omitSizeKey?: boolean;
+    }): Promise<string[]>;
     /**
-     * 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
+     * Return a new instance of cache with customized configuration.
+     * @param {Object} config - the customized configuration
+     * @return {Object} - the new instance of Cache
      */
-    protected fillCacheItem(key: string, value: object | number | string | boolean, options: CacheItemOptions): CacheItem;
-    /**
-     * Set custom configuration for the cache instance.
-     *
-     * @param config - customized configuration (without keyPrefix, which can't be changed)
-     *
-     * @return - the current configuration
-     */
-    configure(config?: Omit<CacheConfig, 'keyPrefix'>): CacheConfig;
-    /**
-     * Returns an appropriate configuration for the Cache instance. Will apply any custom configuration for this
-     * instance on top of the global configuration. Default configuration will be applied in all cases.
-     *
-     * @internal
-     */
-    protected get cacheConfig(): CacheConfig;
+    createInstance(config: CacheConfig): Cache;
 }

package/lib/Cache/StorageCache.js

@@ -1,121 +1,116 @@
 "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 __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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StorageCache = void 0;
-var Utils_1 = require("./Utils");
 var Logger_1 = require("../Logger");
-var logger = new Logger_1.ConsoleLogger('StorageCache');
+var KeyValueStorage_1 = require("../storage/KeyValueStorage");
+var utils_1 = require("../storage/utils");
+var constants_1 = require("./constants");
+var StorageCacheCommon_1 = require("./StorageCacheCommon");
+var utils_2 = require("./utils");
+var logger = new Logger_1.ConsoleLogger('Cache');
 /**
- * Initialization of the cache
- *
+ * Customized storage based on the SessionStorage or LocalStorage with LRU implemented
  */
-var StorageCache = /** @class */ (function () {
+var StorageCache = /** @class */ (function (_super) {
+    __extends(StorageCache, _super);
     /**
-     * Initialize the cache
-     *
-     * @param config - Custom configuration for this instance.
+     * initialize the cache
+     * @param config - the configuration of the cache
      */
     function StorageCache(config) {
-        if (config) {
-            // A configuration was specified for this specific instance
-            this.instanceConfig = config;
-        }
-        this.sanitizeConfig();
+        var _this = this;
+        var storage = (0, utils_1.getLocalStorageWithFallback)();
+        _this = _super.call(this, { config: config, keyValueStorage: new KeyValueStorage_1.KeyValueStorage(storage) }) || this;
+        _this.storage = storage;
+        _this.getItem = _this.getItem.bind(_this);
+        _this.setItem = _this.setItem.bind(_this);
+        _this.removeItem = _this.removeItem.bind(_this);
+        return _this;
     }
-    StorageCache.prototype.getModuleName = function () {
-        return 'Cache';
-    };
-    StorageCache.prototype.sanitizeConfig = function () {
-        var tempInstanceConfig = this.instanceConfig || {};
-        if (this.cacheConfig.itemMaxSize > this.cacheConfig.capacityInBytes) {
-            logger.error('Invalid parameter: itemMaxSize. It should be smaller than capacityInBytes. Setting back to default.');
-            tempInstanceConfig.itemMaxSize = Utils_1.defaultConfig.itemMaxSize;
-        }
-        if (this.cacheConfig.defaultPriority > 5 ||
-            this.cacheConfig.defaultPriority < 1) {
-            logger.error('Invalid parameter: defaultPriority. It should be between 1 and 5. Setting back to default.');
-            tempInstanceConfig.defaultPriority = Utils_1.defaultConfig.defaultPriority;
-        }
-        if (Number(this.cacheConfig.warningThreshold) > 1 ||
-            Number(this.cacheConfig.warningThreshold) < 0) {
-            logger.error('Invalid parameter: warningThreshold. It should be between 0 and 1. Setting back to default.');
-            tempInstanceConfig.warningThreshold = Utils_1.defaultConfig.warningThreshold;
-        }
-        // Set 5MB limit
-        var cacheLimit = 5 * 1024 * 1024;
-        if (this.cacheConfig.capacityInBytes > cacheLimit) {
-            logger.error('Cache Capacity should be less than 5MB. Setting back to default. Setting back to default.');
-            tempInstanceConfig.capacityInBytes = Utils_1.defaultConfig.capacityInBytes;
-        }
-        // Apply sanitized values to the instance config
-        if (Object.keys(tempInstanceConfig).length > 0) {
-            this.instanceConfig = tempInstanceConfig;
-        }
-    };
-    /**
-     * 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
-     */
-    StorageCache.prototype.fillCacheItem = function (key, value, options) {
-        var _a, _b;
-        var ret = {
-            key: key,
-            data: value,
-            timestamp: (0, Utils_1.getCurrTime)(),
-            visitedTime: (0, Utils_1.getCurrTime)(),
-            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,
-        };
-        ret.byteSize = (0, Utils_1.getByteLength)(JSON.stringify(ret));
-        // for accurate size
-        ret.byteSize = (0, Utils_1.getByteLength)(JSON.stringify(ret));
-        return ret;
+    StorageCache.prototype.getAllCacheKeys = function (options) {
+        return __awaiter(this, void 0, void 0, function () {
+            var omitSizeKey, keys, i, key;
+            return __generator(this, function (_a) {
+                omitSizeKey = (options !== null && options !== void 0 ? options : {}).omitSizeKey;
+                keys = [];
+                for (i = 0; i < this.storage.length; i++) {
+                    key = this.storage.key(i);
+                    if (omitSizeKey && key === (0, utils_2.getCurrentSizeKey)(this.config.keyPrefix)) {
+                        continue;
+                    }
+                    if (key === null || key === void 0 ? void 0 : key.startsWith(this.config.keyPrefix)) {
+                        keys.push(key.substring(this.config.keyPrefix.length));
+                    }
+                }
+                return [2 /*return*/, keys];
+            });
+        });
     };
     /**
-     * Set custom configuration for the cache instance.
-     *
-     * @param config - customized configuration (without keyPrefix, which can't be changed)
-     *
-     * @return - the current configuration
+     * Return a new instance of cache with customized configuration.
+     * @param {Object} config - the customized configuration
+     * @return {Object} - the new instance of Cache
      */
-    StorageCache.prototype.configure = function (config) {
-        if (config) {
-            if (config.keyPrefix) {
-                logger.warn('keyPrefix can not be re-configured on an existing Cache instance.');
-            }
-            this.instanceConfig = this.instanceConfig
-                ? Object.assign({}, this.instanceConfig, config)
-                : config;
+    StorageCache.prototype.createInstance = function (config) {
+        if (!config.keyPrefix || config.keyPrefix === constants_1.defaultConfig.keyPrefix) {
+            logger.error('invalid keyPrefix, setting keyPrefix with timeStamp');
+            config.keyPrefix = utils_2.getCurrentTime.toString();
         }
-        this.sanitizeConfig();
-        return this.cacheConfig;
+        return new StorageCache(config);
     };
-    Object.defineProperty(StorageCache.prototype, "cacheConfig", {
-        /**
-         * Returns an appropriate configuration for the Cache instance. Will apply any custom configuration for this
-         * instance on top of the global configuration. Default configuration will be applied in all cases.
-         *
-         * @internal
-         */
-        get: function () {
-            // const globalCacheConfig = Amplify.getConfig().Cache || {};
-            var globalCacheConfig = {};
-            if (this.instanceConfig) {
-                return Object.assign({}, Utils_1.defaultConfig, globalCacheConfig, this.instanceConfig);
-            }
-            else {
-                return Object.assign({}, Utils_1.defaultConfig, globalCacheConfig);
-            }
-        },
-        enumerable: false,
-        configurable: true
-    });
     return StorageCache;
-}());
+}(StorageCacheCommon_1.StorageCacheCommon));
 exports.StorageCache = StorageCache;

package/lib/Cache/StorageCache.native.d.ts

@@ -0,0 +1,19 @@
+import { StorageCacheCommon } from './StorageCacheCommon';
+import { Cache, CacheConfig } from './types';
+export declare class StorageCache extends StorageCacheCommon implements Cache {
+    /**
+     * initialize the cache
+     * @param config - the configuration of the cache
+     */
+    constructor(config?: CacheConfig);
+    protected getAllCacheKeys(options?: {
+        omitSizeKey?: boolean;
+    }): Promise<string[]>;
+    protected getAllStorageKeys(): Promise<readonly string[]>;
+    /**
+     * Return a new instance of cache with customized configuration.
+     * @param {Object} config - the customized configuration
+     * @return {Object} - the new instance of Cache
+     */
+    createInstance(config: CacheConfig): Cache;
+}

package/lib/Cache/StorageCache.native.js

@@ -0,0 +1,164 @@
+"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 __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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        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.StorageCache = void 0;
+var react_native_1 = require("@aws-amplify/react-native");
+var Logger_1 = require("../Logger");
+var constants_1 = require("./constants");
+var StorageCacheCommon_1 = require("./StorageCacheCommon");
+var utils_1 = require("./utils");
+var logger = new Logger_1.ConsoleLogger('StorageCache');
+var AsyncStorage = (0, react_native_1.loadAsyncStorage)();
+/*
+ * Customized cache which based on the AsyncStorage with LRU implemented
+ */
+var StorageCache = /** @class */ (function (_super) {
+    __extends(StorageCache, _super);
+    /**
+     * initialize the cache
+     * @param config - the configuration of the cache
+     */
+    function StorageCache(config) {
+        var _this = _super.call(this, { config: config, keyValueStorage: AsyncStorage }) || this;
+        _this.getItem = _this.getItem.bind(_this);
+        _this.setItem = _this.setItem.bind(_this);
+        _this.removeItem = _this.removeItem.bind(_this);
+        return _this;
+    }
+    StorageCache.prototype.getAllCacheKeys = function (options) {
+        return __awaiter(this, void 0, void 0, function () {
+            var omitSizeKey, keys, _a, _b, key, e_1_1;
+            var e_1, _c;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        omitSizeKey = (options !== null && options !== void 0 ? options : {}).omitSizeKey;
+                        keys = [];
+                        _d.label = 1;
+                    case 1:
+                        _d.trys.push([1, 6, 7, 8]);
+                        return [4 /*yield*/, AsyncStorage.getAllKeys()];
+                    case 2:
+                        _a = __values.apply(void 0, [_d.sent()]), _b = _a.next();
+                        _d.label = 3;
+                    case 3:
+                        if (!!_b.done) return [3 /*break*/, 5];
+                        key = _b.value;
+                        if (omitSizeKey && key === (0, utils_1.getCurrentSizeKey)(this.config.keyPrefix)) {
+                            return [3 /*break*/, 4];
+                        }
+                        if (key === null || key === void 0 ? void 0 : key.startsWith(this.config.keyPrefix)) {
+                            keys.push(key.substring(this.config.keyPrefix.length));
+                        }
+                        _d.label = 4;
+                    case 4:
+                        _b = _a.next();
+                        return [3 /*break*/, 3];
+                    case 5: return [3 /*break*/, 8];
+                    case 6:
+                        e_1_1 = _d.sent();
+                        e_1 = { error: e_1_1 };
+                        return [3 /*break*/, 8];
+                    case 7:
+                        try {
+                            if (_b && !_b.done && (_c = _a.return)) _c.call(_a);
+                        }
+                        finally { if (e_1) throw e_1.error; }
+                        return [7 /*endfinally*/];
+                    case 8: return [2 /*return*/, keys];
+                }
+            });
+        });
+    };
+    StorageCache.prototype.getAllStorageKeys = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                try {
+                    return [2 /*return*/, AsyncStorage.getAllKeys()];
+                }
+                catch (e) {
+                    logger.warn("getAllKeys failed! ".concat(e));
+                    return [2 /*return*/, []];
+                }
+                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
+     */
+    StorageCache.prototype.createInstance = function (config) {
+        if (!config.keyPrefix || config.keyPrefix === constants_1.defaultConfig.keyPrefix) {
+            logger.error('invalid keyPrefix, setting keyPrefix with timeStamp');
+            config.keyPrefix = utils_1.getCurrentTime.toString();
+        }
+        return new StorageCache(config);
+    };
+    return StorageCache;
+}(StorageCacheCommon_1.StorageCacheCommon));
+exports.StorageCache = StorageCache;