@aws-amplify/cache 4.0.64-unstable.4 → 4.0.64

package/src/Utils/CacheList.ts

@@ -1,5 +1,15 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
+/*
+ * Copyright 2017-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
 
 class DoubleLinkedNode {
 	key: string;

package/src/Utils/CacheUtils.ts

@@ -1,5 +1,15 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
+/*
+ * Copyright 2017-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
 
 import { CacheConfig, CacheItem, CacheItemOptions } from '../types';
 import { StorageHelper } from '@aws-amplify/core';

package/src/Utils/index.ts

@@ -1,11 +1,15 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-export {
-	CacheObject,
-	defaultConfig,
-	getByteLength,
-	getCurrTime,
-	isInteger,
-} from './CacheUtils';
-export { default as CacheList } from './CacheList';
+/*
+ * Copyright 2017-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
+
+export * from './CacheUtils';
+export { default as CacheList } from './CacheList';

package/src/index.ts

@@ -1,11 +1,27 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
+/*
+ * Copyright 2017-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
 
+import { Amplify } from '@aws-amplify/core';
 import { BrowserStorageCache } from './BrowserStorageCache';
 import { InMemoryCache } from './InMemoryCache';
 import { CacheConfig } from './types';
 
 export { BrowserStorageCache, InMemoryCache, CacheConfig };
-
-// Standard `Cache` export to maintain interoperability with React Native
 export { BrowserStorageCache as Cache };
+
+/**
+ * @deprecated use named import
+ */
+export default BrowserStorageCache;
+
+Amplify.register(BrowserStorageCache);

package/src/reactnative.ts

@@ -1,9 +1,23 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
+/*
+ * Copyright 2017-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
 
+import { Amplify } from '@aws-amplify/core';
 import { Cache, AsyncStorageCache } from './AsyncStorageCache';
 
-export { AsyncStorageCache };
+export { Cache, AsyncStorageCache };
+/**
+ * @deprecated use named import
+ */
+export default Cache;
 
-// Standard `Cache` export to maintain interoperability with React Native
-export { Cache };
+Amplify.register(Cache);

package/src/types/Cache.ts

@@ -1,5 +1,15 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
+/*
+ * Copyright 2017-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
 
 /**
  * Cache Interface

package/src/types/index.ts

@@ -1,4 +1,14 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
+/*
+ * Copyright 2017-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
 
 export * from './Cache';

package/webpack.config.dev.js

@@ -0,0 +1,6 @@
+var config = require('./webpack.config.js');
+
+var entry = {
+	'aws-amplify-cache': './lib-esm/index.js',
+};
+module.exports = Object.assign(config, { entry, mode: 'development' });

package/lib/.tsbuildinfo

@@ -1,3 +0,0 @@
-{
-  "version": "3.8.3"
-}

package/lib/AsyncStorageCache.d.ts

@@ -1,154 +0,0 @@
-import AsyncStorage from '@react-native-async-storage/async-storage';
-import { StorageCache } from './StorageCache';
-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 };

package/lib/BrowserStorageCache.d.ts

@@ -1,165 +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;

package/lib/InMemoryCache.d.ts

@@ -1,131 +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;

package/lib/StorageCache.d.ts

@@ -1,31 +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;
-}