@aws-amplify/core 6.0.1-preview-testing.be90020.0 → 6.0.1-ssr-api.df60e41.0

package/lib/Cache/InMemoryCache.d.ts

@@ -1,129 +0,0 @@
-import { StorageCache } from './StorageCache';
-import { ICache, CacheConfig, CacheItemOptions } from './types';
-/**
- * Customized in-memory cache with LRU implemented
- * @member cacheObj - object which store items
- * @member cacheList - list of keys in the cache with LRU
- * @member curSizeInBytes - current size of the cache
- * @member maxPriority - max of the priority
- */
-export declare class InMemoryCacheClass extends StorageCache implements ICache {
-    private cacheList;
-    private curSizeInBytes;
-    private maxPriority;
-    /**
-     * initialize the cache
-     *
-     * @param config - the configuration of the cache
-     */
-    constructor(config?: CacheConfig);
-    /**
-     * decrease current size of the cache
-     *
-     * @param amount - the amount of the cache size which needs to be decreased
-     */
-    private _decreaseCurSizeInBytes;
-    /**
-     * increase current size of the cache
-     *
-     * @param amount - the amount of the cache szie which need to be increased
-     */
-    private _increaseCurSizeInBytes;
-    /**
-     * check whether item is expired
-     *
-     * @param key - the key of the item
-     *
-     * @return true if the item is expired.
-     */
-    private _isExpired;
-    /**
-     * delete item from cache
-     *
-     * @param prefixedKey - the key of the item
-     * @param listIdx - indicates which cache list the key belongs to
-     */
-    private _removeItem;
-    /**
-     * put item into cache
-     *
-     * @param prefixedKey - the key of the item
-     * @param itemData - the value of the item
-     * @param itemSizeInBytes - the byte size of the item
-     * @param listIdx - indicates which cache list the key belongs to
-     */
-    private _setItem;
-    /**
-     * see whether cache is full
-     *
-     * @param itemSize
-     *
-     * @return true if cache is full
-     */
-    private _isCacheFull;
-    /**
-     * check whether the cache contains the key
-     *
-     * @param key
-     */
-    private containsKey;
-    /**
-     * * 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 key - the key of the item
-     * @param value - the value of the item
-     * @param options - optional, the specified meta-data
-     *
-     * @throws if the item is too big which exceeds the limit of single item size
-     * @throws if the key is invalid
-     */
-    setItem(key: string, value: object | string | number | boolean, options?: CacheItemOptions): void;
-    /**
-     * 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
-     *
-     * @param key - the key of the item
-     * @param options - the options of callback function
-     */
-    getItem(key: string, options?: CacheItemOptions): any;
-    /**
-     * remove item from the cache
-     *
-     * @param key - the key of the item
-     */
-    removeItem(key: string): void;
-    /**
-     * clear the entire cache
-     */
-    clear(): void;
-    /**
-     * Return all the keys in the cache.
-     */
-    getAllKeys(): string[];
-    /**
-     * return the current size of the cache
-     *
-     * @return the current size of the cache
-     */
-    getCacheCurSize(): number;
-    /**
-     * Return a new instance of cache with customized configuration.
-     * @param config - the customized configuration
-     */
-    createInstance(config: CacheConfig): ICache;
-}
-export declare const InMemoryCache: ICache;

package/lib/Cache/InMemoryCache.js

@@ -1,349 +0,0 @@
-"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 __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.InMemoryCache = exports.InMemoryCacheClass = void 0;
-var Utils_1 = require("./Utils");
-var StorageCache_1 = require("./StorageCache");
-var Logger_1 = require("../Logger");
-var AssertError_1 = require("../Util/errors/AssertError");
-var Constants_1 = require("../Util/Constants");
-var CacheUtils_1 = require("./Utils/CacheUtils");
-var logger = new Logger_1.ConsoleLogger('InMemoryCache');
-/**
- * Customized in-memory cache with LRU implemented
- * @member cacheObj - object which store items
- * @member cacheList - list of keys in the cache with LRU
- * @member curSizeInBytes - current size of the cache
- * @member maxPriority - max of the priority
- */
-var InMemoryCacheClass = /** @class */ (function (_super) {
-    __extends(InMemoryCacheClass, _super);
-    /**
-     * initialize the cache
-     *
-     * @param config - the configuration of the cache
-     */
-    function InMemoryCacheClass(config) {
-        var _this = _super.call(this, config) || this;
-        _this.cacheList = [];
-        _this.curSizeInBytes = 0;
-        _this.maxPriority = 5;
-        _this.getItem = _this.getItem.bind(_this);
-        _this.setItem = _this.setItem.bind(_this);
-        _this.removeItem = _this.removeItem.bind(_this);
-        // initialize list for every priority
-        for (var i = 0; i < _this.maxPriority; i += 1) {
-            _this.cacheList[i] = new Utils_1.CacheList();
-        }
-        return _this;
-    }
-    /**
-     * decrease current size of the cache
-     *
-     * @param amount - the amount of the cache size which needs to be decreased
-     */
-    InMemoryCacheClass.prototype._decreaseCurSizeInBytes = function (amount) {
-        this.curSizeInBytes -= amount;
-    };
-    /**
-     * increase current size of the cache
-     *
-     * @param amount - the amount of the cache szie which need to be increased
-     */
-    InMemoryCacheClass.prototype._increaseCurSizeInBytes = function (amount) {
-        this.curSizeInBytes += amount;
-    };
-    /**
-     * check whether item is expired
-     *
-     * @param key - the key of the item
-     *
-     * @return true if the item is expired.
-     */
-    InMemoryCacheClass.prototype._isExpired = function (key) {
-        var text = Utils_1.CacheObject.getItem(key);
-        (0, AssertError_1.asserts)(text !== null, {
-            name: Constants_1.STORAGE_CACHE_EXCEPTION,
-            message: 'item from storage is null',
-        });
-        var item = JSON.parse(text);
-        if ((0, Utils_1.getCurrTime)() >= item.expires) {
-            return true;
-        }
-        return false;
-    };
-    /**
-     * delete item from cache
-     *
-     * @param prefixedKey - the key of the item
-     * @param listIdx - indicates which cache list the key belongs to
-     */
-    InMemoryCacheClass.prototype._removeItem = function (prefixedKey, listIdx) {
-        // delete the key from the list
-        this.cacheList[listIdx].removeItem(prefixedKey);
-        // decrease the current size of the cache
-        var item = Utils_1.CacheObject.getItem(prefixedKey);
-        (0, AssertError_1.asserts)(item !== null, {
-            name: Constants_1.STORAGE_CACHE_EXCEPTION,
-            message: 'item from storage is null',
-        });
-        this._decreaseCurSizeInBytes(JSON.parse(item).byteSize);
-        // finally remove the item from memory
-        Utils_1.CacheObject.removeItem(prefixedKey);
-    };
-    /**
-     * put item into cache
-     *
-     * @param prefixedKey - the key of the item
-     * @param itemData - the value of the item
-     * @param itemSizeInBytes - the byte size of the item
-     * @param listIdx - indicates which cache list the key belongs to
-     */
-    InMemoryCacheClass.prototype._setItem = function (prefixedKey, item, listIdx) {
-        // insert the key into the list
-        this.cacheList[listIdx].insertItem(prefixedKey);
-        // increase the current size of the cache
-        this._increaseCurSizeInBytes(item.byteSize);
-        // finally add the item into memory
-        Utils_1.CacheObject.setItem(prefixedKey, JSON.stringify(item));
-    };
-    /**
-     * see whether cache is full
-     *
-     * @param itemSize
-     *
-     * @return true if cache is full
-     */
-    InMemoryCacheClass.prototype._isCacheFull = function (itemSize) {
-        return this.curSizeInBytes + itemSize > this.cacheConfig.capacityInBytes;
-    };
-    /**
-     * check whether the cache contains the key
-     *
-     * @param key
-     */
-    InMemoryCacheClass.prototype.containsKey = function (key) {
-        var prefixedKey = this.cacheConfig.keyPrefix + key;
-        for (var i = 0; i < this.maxPriority; i += 1) {
-            if (this.cacheList[i].containsKey(prefixedKey)) {
-                return i + 1;
-            }
-        }
-        return -1;
-    };
-    /**
-     * * 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 key - the key of the item
-     * @param value - the value of the item
-     * @param options - optional, the specified meta-data
-     *
-     * @throws if the item is too big which exceeds the limit of single item size
-     * @throws if the key is invalid
-     */
-    InMemoryCacheClass.prototype.setItem = function (key, value, options) {
-        var 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;
-        }
-        if (typeof value === 'undefined') {
-            logger.warn("The value of item should not be undefined!");
-            return;
-        }
-        var 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;
-        }
-        var 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;
-        }
-        // if key already in the cache, then delete it.
-        var presentKeyPrio = this.containsKey(key);
-        if (presentKeyPrio !== -1) {
-            this._removeItem(prefixedKey, presentKeyPrio - 1);
-        }
-        // pop out items in the cache when cache is full based on LRU
-        // first start from lowest priority cache list
-        var cacheListIdx = this.maxPriority - 1;
-        while (this._isCacheFull(item.byteSize) && cacheListIdx >= 0) {
-            if (!this.cacheList[cacheListIdx].isEmpty()) {
-                var popedItemKey = this.cacheList[cacheListIdx].getLastItem();
-                this._removeItem(popedItemKey, cacheListIdx);
-            }
-            else {
-                cacheListIdx -= 1;
-            }
-        }
-        this._setItem(prefixedKey, item, Number(item.priority) - 1);
-    };
-    /**
-     * 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
-     *
-     * @param key - the key of the item
-     * @param options - the options of callback function
-     */
-    InMemoryCacheClass.prototype.getItem = function (key, options) {
-        var _a;
-        var ret = null;
-        var 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 null;
-        }
-        // check whether it's in the cachelist
-        var presentKeyPrio = this.containsKey(key);
-        if (presentKeyPrio !== -1) {
-            if (this._isExpired(prefixedKey)) {
-                // if expired, remove that item and return null
-                this._removeItem(prefixedKey, presentKeyPrio - 1);
-            }
-            else {
-                // if not expired, great, return the value and refresh it
-                ret = (_a = Utils_1.CacheObject.getItem(prefixedKey)) !== null && _a !== void 0 ? _a : '';
-                var item = JSON.parse(ret);
-                this.cacheList[item.priority - 1].refresh(prefixedKey);
-                return item.data;
-            }
-        }
-        if (options && options.callback !== undefined) {
-            var val = options.callback();
-            if (val !== null) {
-                this.setItem(key, val, options);
-            }
-            return val;
-        }
-        return null;
-    };
-    /**
-     * remove item from the cache
-     *
-     * @param key - the key of the item
-     */
-    InMemoryCacheClass.prototype.removeItem = function (key) {
-        var prefixedKey = this.cacheConfig.keyPrefix + key;
-        // check if the key is in the cache
-        var presentKeyPrio = this.containsKey(key);
-        if (presentKeyPrio !== -1) {
-            this._removeItem(prefixedKey, presentKeyPrio - 1);
-        }
-    };
-    /**
-     * clear the entire cache
-     */
-    InMemoryCacheClass.prototype.clear = function () {
-        var e_1, _a;
-        for (var i = 0; i < this.maxPriority; i += 1) {
-            try {
-                for (var _b = (e_1 = void 0, __values(this.cacheList[i].getKeys())), _c = _b.next(); !_c.done; _c = _b.next()) {
-                    var key = _c.value;
-                    this._removeItem(key, i);
-                }
-            }
-            catch (e_1_1) { e_1 = { error: e_1_1 }; }
-            finally {
-                try {
-                    if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
-                }
-                finally { if (e_1) throw e_1.error; }
-            }
-        }
-    };
-    /**
-     * Return all the keys in the cache.
-     */
-    InMemoryCacheClass.prototype.getAllKeys = function () {
-        var e_2, _a;
-        var keys = [];
-        for (var i = 0; i < this.maxPriority; i += 1) {
-            try {
-                for (var _b = (e_2 = void 0, __values(this.cacheList[i].getKeys())), _c = _b.next(); !_c.done; _c = _b.next()) {
-                    var key = _c.value;
-                    keys.push(key.substring(this.cacheConfig.keyPrefix.length));
-                }
-            }
-            catch (e_2_1) { e_2 = { error: e_2_1 }; }
-            finally {
-                try {
-                    if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
-                }
-                finally { if (e_2) throw e_2.error; }
-            }
-        }
-        return keys;
-    };
-    /**
-     * return the current size of the cache
-     *
-     * @return the current size of the cache
-     */
-    InMemoryCacheClass.prototype.getCacheCurSize = function () {
-        return this.curSizeInBytes;
-    };
-    /**
-     * Return a new instance of cache with customized configuration.
-     * @param config - the customized configuration
-     */
-    InMemoryCacheClass.prototype.createInstance = function (config) {
-        return new InMemoryCacheClass(config);
-    };
-    return InMemoryCacheClass;
-}(StorageCache_1.StorageCache));
-exports.InMemoryCacheClass = InMemoryCacheClass;
-exports.InMemoryCache = new InMemoryCacheClass();

package/lib/Cache/Utils/CacheList.js

@@ -1,196 +0,0 @@
-"use strict";
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-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 });
-var AssertError_1 = require("../../Util/errors/AssertError");
-var Constants_1 = require("../../Util/Constants");
-var DoubleLinkedNode = /** @class */ (function () {
-    function DoubleLinkedNode(keyVal) {
-        this.key = keyVal ? keyVal : '';
-        this.prevNode = null;
-        this.nextNode = null;
-    }
-    return DoubleLinkedNode;
-}());
-/**
- * double linked list plus a hash table inside
- * each key in the cache stored as a node in the list
- * recently visited node will be rotated to the head
- * so the Last Recently Visited node will be at the tail
- *
- * @member head - dummy head of the linked list
- * @member tail - dummy tail of the linked list
- * @member hashtable - the hashtable which maps cache key to list node
- * @member length - length of the list
- */
-var CacheList = /** @class */ (function () {
-    /**
-     * initialization
-     */
-    function CacheList() {
-        this.head = new DoubleLinkedNode();
-        this.tail = new DoubleLinkedNode();
-        this.hashtable = {};
-        this.length = 0;
-        this.head.nextNode = this.tail;
-        this.tail.prevNode = this.head;
-    }
-    /**
-     * insert node to the head of the list
-     *
-     * @param node
-     */
-    CacheList.prototype.insertNodeToHead = function (node) {
-        var tmp = this.head.nextNode;
-        this.head.nextNode = node;
-        node.nextNode = tmp;
-        node.prevNode = this.head;
-        (0, AssertError_1.asserts)(tmp !== null, {
-            name: Constants_1.CACHE_LIST_EXCEPTION,
-            message: 'previous node is null',
-        });
-        tmp.prevNode = node;
-        this.length = this.length + 1;
-    };
-    /**
-     * remove node
-     *
-     * @param node
-     */
-    CacheList.prototype.removeNode = function (node) {
-        (0, AssertError_1.asserts)(node.prevNode !== null, {
-            name: Constants_1.CACHE_LIST_EXCEPTION,
-            message: 'previous node is null',
-        });
-        (0, AssertError_1.asserts)(node.nextNode !== null, {
-            name: Constants_1.CACHE_LIST_EXCEPTION,
-            message: 'nextNode node is null',
-        });
-        node.prevNode.nextNode = node.nextNode;
-        node.nextNode.prevNode = node.prevNode;
-        node.prevNode = null;
-        node.nextNode = null;
-        this.length = this.length - 1;
-    };
-    /**
-     * @return true if list is empty
-     */
-    CacheList.prototype.isEmpty = function () {
-        return this.length === 0;
-    };
-    /**
-     * refresh node so it is rotated to the head
-     *
-     * @param key - key of the node
-     */
-    CacheList.prototype.refresh = function (key) {
-        var node = this.hashtable[key];
-        this.removeNode(node);
-        this.insertNodeToHead(node);
-    };
-    /**
-     * insert new node to the head and add it in the hashtable
-     *
-     * @param key - the key of the node
-     */
-    CacheList.prototype.insertItem = function (key) {
-        var node = new DoubleLinkedNode(key);
-        this.hashtable[key] = node;
-        this.insertNodeToHead(node);
-    };
-    /**
-     * @return the LAST Recently Visited key
-     */
-    CacheList.prototype.getLastItem = function () {
-        (0, AssertError_1.asserts)(this.tail.prevNode !== null, {
-            name: Constants_1.CACHE_LIST_EXCEPTION,
-            message: 'previous node is null',
-        });
-        return this.tail.prevNode.key;
-    };
-    /**
-     * remove the cache key from the list and hashtable
-     * @param key - the key of the node
-     */
-    CacheList.prototype.removeItem = function (key) {
-        var removedItem = this.hashtable[key];
-        this.removeNode(removedItem);
-        delete this.hashtable[key];
-    };
-    /**
-     * @return length of the list
-     */
-    CacheList.prototype.getSize = function () {
-        return this.length;
-    };
-    /**
-     * @return true if the key is in the hashtable
-     * @param key
-     */
-    CacheList.prototype.containsKey = function (key) {
-        return key in this.hashtable;
-    };
-    /**
-     * clean up the list and hashtable
-     */
-    CacheList.prototype.clearList = function () {
-        var e_1, _a;
-        try {
-            for (var _b = __values(Object.keys(this.hashtable)), _c = _b.next(); !_c.done; _c = _b.next()) {
-                var key = _c.value;
-                if (this.hashtable.hasOwnProperty(key)) {
-                    delete this.hashtable[key];
-                }
-            }
-        }
-        catch (e_1_1) { e_1 = { error: e_1_1 }; }
-        finally {
-            try {
-                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
-            }
-            finally { if (e_1) throw e_1.error; }
-        }
-        this.head.nextNode = this.tail;
-        this.tail.prevNode = this.head;
-        this.length = 0;
-    };
-    /**
-     * @return all keys in the hashtable
-     */
-    CacheList.prototype.getKeys = function () {
-        return Object.keys(this.hashtable);
-    };
-    /**
-     * mainly for test
-     *
-     * @param key
-     * @return true if key is the head node
-     */
-    CacheList.prototype.isHeadNode = function (key) {
-        var node = this.hashtable[key];
-        return node.prevNode === this.head;
-    };
-    /**
-     * mainly for test
-     *
-     * @param key
-     * @return true if key is the tail node
-     */
-    CacheList.prototype.isTailNode = function (key) {
-        var node = this.hashtable[key];
-        return node.nextNode === this.tail;
-    };
-    return CacheList;
-}());
-exports.default = CacheList;

package/lib/Cache/Utils/CacheUtils.d.ts

@@ -1,25 +0,0 @@
-import { CacheConfig } from '../types';
-/**
- * Default cache config
- */
-export declare const defaultConfig: CacheConfig;
-/**
- * return the byte size of the string
- * @param str
- */
-export declare function getByteLength(str: string): number;
-/**
- * get current time
- */
-export declare function getCurrTime(): number;
-/**
- * check if passed value is an integer
- */
-export declare function isInteger(value?: number): boolean;
-export declare class CacheObject {
-    static clear(): void;
-    static getItem(key: string): string | null;
-    static setItem(key: string, value: string): void;
-    static removeItem(key: string): void;
-}
-export declare const getCurrSizeKey: (keyPrefix: string) => string;