@aws-amplify/cache 4.0.59-unstable.3 → 4.0.60-unstable.10

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [4.0.59](https://github.com/aws-amplify/amplify-js/compare/@aws-amplify/cache@4.0.58...@aws-amplify/cache@4.0.59) (2022-10-14)
+
+**Note:** Version bump only for package @aws-amplify/cache
+
+
+
+
+
 ## [4.0.58](https://github.com/aws-amplify/amplify-js/compare/@aws-amplify/cache@4.0.57...@aws-amplify/cache@4.0.58) (2022-10-14)
 
 **Note:** Version bump only for package @aws-amplify/cache

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/cache",
-  "version": "4.0.59-unstable.3+42ae8de62",
+  "version": "4.0.60-unstable.10+7a2f3ecf0",
   "description": "Cache category of aws-amplify",
   "main": "./lib/index.js",
   "module": "./lib-esm/index.js",
@@ -44,7 +44,7 @@
   },
   "homepage": "https://aws-amplify.github.io/",
   "dependencies": {
-    "@aws-amplify/core": "4.7.8-unstable.3+42ae8de62"
+    "@aws-amplify/core": "4.7.9-unstable.10+7a2f3ecf0"
   },
   "jest": {
     "globals": {
@@ -94,5 +94,5 @@
       "lib-esm"
     ]
   },
-  "gitHead": "42ae8de62f53e7d81363c0dd676967454271259a"
+  "gitHead": "7a2f3ecf0fda83f087b1c2ce650f4b5f00214dbe"
 }

package/lib/AsyncStorageCache.d.ts

@@ -1,155 +0,0 @@
-import { StorageCache } from './StorageCache';
-import AsyncStorage from '@react-native-async-storage/async-storage';
-import { ICache } from './types';
-export declare class AsyncStorageCache extends StorageCache implements ICache {
-    /**
-     * initialize the cache
-     *
-     * @param {Object} config - the configuration of the cache
-     */
-    constructor(config?: any);
-    /**
-     * decrease current size of the cache
-     * @private
-     * @param amount - the amount of the cache size which needs to be decreased
-     */
-    _decreaseCurSizeInBytes(amount: any): Promise<void>;
-    /**
-     * increase current size of the cache
-     * @private
-     * @param amount - the amount of the cache szie which need to be increased
-     */
-    _increaseCurSizeInBytes(amount: any): Promise<void>;
-    /**
-     * 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
-     *
-     * @return the refreshed item
-     */
-    _refreshItem(item: any, prefixedKey: any): Promise<any>;
-    /**
-     * check wether item is expired
-     * @private
-     * @param key - the key of the item
-     *
-     * @return true if the item is expired.
-     */
-    _isExpired(key: any): Promise<boolean>;
-    /**
-     * delete item from cache
-     * @private
-     * @param prefixedKey - the key of the item
-     * @param size - optional, the byte size of the item
-     */
-    _removeItem(prefixedKey: any, size?: any): Promise<void>;
-    /**
-     * 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
-     */
-    _setItem(prefixedKey: any, item: any): Promise<void>;
-    /**
-     * total space needed when poping out items
-     * @private
-     * @param itemSize
-     *
-     * @return total space needed
-     */
-    _sizeToPop(itemSize: any): Promise<number>;
-    /**
-     * see whether cache is full
-     * @private
-     * @param itemSize
-     *
-     * @return true if cache is full
-     */
-    _isCacheFull(itemSize: any): Promise<boolean>;
-    /**
-     * 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
-     */
-    _findValidKeys(): Promise<any[]>;
-    /**
-     * get all the items we have, sort them by their priority,
-     * if priority is same, sort them by their last visited time
-     * pop out items from the low priority (5 is the lowest)
-     * @private
-     * @param keys - all the keys in this cache
-     * @param sizeToPop - the total size of the items which needed to be poped out
-     */
-    _popOutItems(keys: any, sizeToPop: any): Promise<void>;
-    /**
-     * 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 {Prmoise}
-     */
-    setItem(key: any, value: any, options: any): Promise<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
-     * 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
-     */
-    getItem(key: any, options: any): Promise<any>;
-    /**
-     * 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}
-     */
-    removeItem(key: any): Promise<void>;
-    /**
-     * clear the entire cache
-     * The cache will abort output a warning:
-     * If error happened with AsyncStorage
-     * @return {Promise}
-     */
-    clear(): Promise<void>;
-    /**
-     * return the current size of the cache
-     * @return {Promise}
-     */
-    getCacheCurSize(): Promise<number>;
-    /**
-     * Return all the keys in the cache.
-     * Will return an empty array if error happend.
-     * @return {Promise}
-     */
-    getAllKeys(): Promise<any[]>;
-    /**
-     * Return a new instance of cache with customized configuration.
-     * @param {Object} config - the customized configuration
-     * @return {Object} - the new instance of Cache
-     */
-    createInstance(config: any): ICache;
-}
-declare const instance: ICache;
-export { AsyncStorage, instance as Cache };
-export default instance;

package/lib/BrowserStorageCache.d.ts

@@ -1,169 +0,0 @@
-import { StorageCache } from './StorageCache';
-import { ICache, CacheConfig, CacheItemOptions } from './types';
-/**
- * Customized storage based on the SessionStorage or LocalStorage with LRU implemented
- */
-export declare class BrowserStorageCacheClass extends StorageCache implements ICache {
-    /**
-     * initialize the cache
-     * @param config - the configuration of the cache
-     */
-    constructor(config?: CacheConfig);
-    /**
-     * decrease current size of the cache
-     *
-     * @private
-     * @param amount - the amount of the cache size which needs to be decreased
-     */
-    private _decreaseCurSizeInBytes;
-    /**
-     * increase current size of the cache
-     *
-     * @private
-     * @param amount - the amount of the cache szie which need to be increased
-     */
-    private _increaseCurSizeInBytes;
-    /**
-     * 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
-     *
-     * @return the refreshed item
-     */
-    private _refreshItem;
-    /**
-     * check wether item is expired
-     *
-     * @private
-     * @param key - the key of the item
-     *
-     * @return true if the item is expired.
-     */
-    private _isExpired;
-    /**
-     * delete item from cache
-     *
-     * @private
-     * @param prefixedKey - the key of the item
-     * @param size - optional, the byte size of the item
-     */
-    private _removeItem;
-    /**
-     * 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
-     */
-    private _setItem;
-    /**
-     * total space needed when poping out items
-     *
-     * @private
-     * @param itemSize
-     *
-     * @return total space needed
-     */
-    private _sizeToPop;
-    /**
-     * see whether cache is full
-     *
-     * @private
-     * @param itemSize
-     *
-     * @return true if cache is full
-     */
-    private _isCacheFull;
-    /**
-     * 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
-     */
-    private _findValidKeys;
-    /**
-     * get all the items we have, sort them by their priority,
-     * if priority is same, sort them by their last visited time
-     * pop out items from the low priority (5 is the lowest)
-     *
-     * @private
-     * @param keys - all the keys in this cache
-     * @param sizeToPop - the total size of the items which needed to be poped out
-     */
-    private _popOutItems;
-    /**
-     * 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 {Object} [options] - optional, the specified meta-data
-     */
-    setItem(key: string, value: object | number | string | 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
-     * If error happened with browser storage
-     *
-     * @param key - the key of the item
-     * @param {Object} [options] - the options of callback function
-     *
-     * @return - return the value of the item
-     */
-    getItem(key: string, options?: CacheItemOptions): any;
-    /**
-     * remove item from the cache
-     * The cache will abort output a warning:
-     * If error happened with browser storage
-     * @param key - the key of the item
-     */
-    removeItem(key: string): void;
-    /**
-     * clear the entire cache
-     * The cache will abort output a warning:
-     * If error happened with browser storage
-     */
-    clear(): void;
-    /**
-     * Return all the keys in the cache.
-     *
-     * @return - all keys in the cache
-     */
-    getAllKeys(): string[];
-    /**
-     * return the current size of the cache
-     *
-     * @return - current size of the cache
-     */
-    getCacheCurSize(): number;
-    /**
-     * Return a new instance of cache with customized configuration.
-     * @param config - the customized configuration
-     *
-     * @return - new instance of Cache
-     */
-    createInstance(config: CacheConfig): ICache;
-}
-export declare const BrowserStorageCache: ICache;
-/**
- * @deprecated use named import
- */
-export default BrowserStorageCache;

package/lib/InMemoryCache.d.ts

@@ -1,135 +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
- * @member cacheSizeLimit - the limit of cache size
- */
-export declare class InMemoryCacheClass extends StorageCache implements ICache {
-    private cacheList;
-    private curSizeInBytes;
-    private maxPriority;
-    private cacheSizeLimit;
-    /**
-     * 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;
-/**
- * @deprecated use named import
- */
-export default InMemoryCache;

package/lib/StorageCache.d.ts

@@ -1,35 +0,0 @@
-import { CacheConfig, CacheItem, CacheItemOptions } from './types';
-/**
- * Initialization of the cache
- *
- */
-export declare class StorageCache {
-    protected cacheCurSizeKey: string;
-    protected config: CacheConfig;
-    /**
-     * Initialize the cache
-     * @param config - the configuration of the cache
-     */
-    constructor(config: CacheConfig);
-    getModuleName(): string;
-    private checkConfig;
-    /**
-     * 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
-     */
-    protected fillCacheItem(key: string, value: object | number | string | boolean, options: CacheItemOptions): CacheItem;
-    /**
-     * set cache with customized configuration
-     * @param config - customized configuration
-     *
-     * @return - the current configuration
-     */
-    configure(config?: CacheConfig): CacheConfig;
-}
-/**
- * @deprecated use named import
- */
-export default StorageCache;

package/lib/Utils/CacheList.d.ts

@@ -1,89 +0,0 @@
-/**
- * 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
- */
-export default class CacheList {
-    private head;
-    private tail;
-    private hashtable;
-    private length;
-    /**
-     * initialization
-     */
-    constructor();
-    /**
-     * insert node to the head of the list
-     *
-     * @param node
-     */
-    private insertNodeToHead;
-    /**
-     * remove node
-     *
-     * @param node
-     */
-    private removeNode;
-    /**
-     * @return true if list is empty
-     */
-    isEmpty(): boolean;
-    /**
-     * refresh node so it is rotated to the head
-     *
-     * @param key - key of the node
-     */
-    refresh(key: string): void;
-    /**
-     * insert new node to the head and add it in the hashtable
-     *
-     * @param key - the key of the node
-     */
-    insertItem(key: string): void;
-    /**
-     * @return the LAST Recently Visited key
-     */
-    getLastItem(): string;
-    /**
-     * remove the cache key from the list and hashtable
-     * @param key - the key of the node
-     */
-    removeItem(key: string): void;
-    /**
-     * @return length of the list
-     */
-    getSize(): number;
-    /**
-     * @return true if the key is in the hashtable
-     * @param key
-     */
-    containsKey(key: string): boolean;
-    /**
-     * clean up the list and hashtable
-     */
-    clearList(): void;
-    /**
-     * @return all keys in the hashtable
-     */
-    getKeys(): string[];
-    /**
-     * mainly for test
-     *
-     * @param key
-     * @return true if key is the head node
-     */
-    isHeadNode(key: string): boolean;
-    /**
-     * mainly for test
-     *
-     * @param key
-     * @return true if key is the tail node
-     */
-    isTailNode(key: string): boolean;
-}

package/lib/Utils/CacheUtils.d.ts

@@ -1,24 +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: any): 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;
-}

package/lib/Utils/index.d.ts

@@ -1,2 +0,0 @@
-export * from './CacheUtils';
-export { default as CacheList } from './CacheList';

package/lib/index.d.ts

@@ -1,8 +0,0 @@
-import { BrowserStorageCache } from './BrowserStorageCache';
-import { InMemoryCache } from './InMemoryCache';
-import { CacheConfig } from './types';
-export { BrowserStorageCache, InMemoryCache, CacheConfig };
-/**
- * @deprecated use named import
- */
-export default BrowserStorageCache;

package/lib/reactnative.d.ts

@@ -1,6 +0,0 @@
-import { Cache, AsyncStorageCache } from './AsyncStorageCache';
-export { Cache, AsyncStorageCache };
-/**
- * @deprecated use named import
- */
-export default Cache;

package/lib/types/Cache.d.ts

@@ -1,55 +0,0 @@
-/**
- * Cache Interface
- */
-export interface ICache {
-    /** Put item into cache */
-    setItem(key: string, value: any, options?: CacheItemOptions): void;
-    /** Get item from cache */
-    getItem(key: string, options?: CacheItemOptions): any;
-    /** Remove item from cache */
-    removeItem(key: string): void;
-    /** Remove all items from cache */
-    clear(): void;
-    /** Get all keys form cache */
-    getAllKeys(): string[] | Promise<string[]>;
-    /** Get current size of the cache */
-    getCacheCurSize(): number | Promise<number>;
-    /** create a new instance with customized config */
-    createInstance(config: CacheConfig): ICache;
-    /** change current configuration */
-    configure(config: CacheConfig): CacheConfig;
-}
-/**
- * Cache instance options
- */
-export interface CacheConfig {
-    /** Prepend to key to avoid conflicts */
-    keyPrefix?: string;
-    /** Cache capacity, in bytes */
-    capacityInBytes?: number;
-    /** Max size of one item */
-    itemMaxSize?: number;
-    /** Time to live, in milliseconds */
-    defaultTTL?: number;
-    /** Warn when over threshold percentage of capacity, maximum 1 */
-    warningThreshold?: number;
-    /** default priority number put on cached items */
-    defaultPriority?: number;
-    storage?: Storage;
-    Cache?: Cache;
-}
-export interface CacheItem {
-    key: string;
-    data: any;
-    timestamp: number;
-    visitedTime: number;
-    priority: number;
-    expires: number;
-    type: string;
-    byteSize: number;
-}
-export interface CacheItemOptions {
-    priority?: number;
-    expires?: number;
-    callback?: Function;
-}

package/lib/types/index.d.ts

@@ -1 +0,0 @@
-export * from './Cache';