@aws-amplify/core 6.0.1-preview-testing.034e780.0 → 6.0.1-server-generate-client.1e317a1.0

package/src/Cache/InMemoryCache.ts

@@ -1,354 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import { CacheList, defaultConfig, getCurrTime, CacheObject } from './Utils';
-
-import { StorageCache } from './StorageCache';
-import { ICache, CacheConfig, CacheItem, CacheItemOptions } from './types';
-import { ConsoleLogger as Logger } from '../Logger';
-import { asserts } from '../Util/errors/AssertError';
-import { STORAGE_CACHE_EXCEPTION } from '../Util/Constants';
-import { getCurrSizeKey } from './Utils/CacheUtils';
-
-const logger = new Logger('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
- */
-export class InMemoryCacheClass extends StorageCache implements ICache {
-	private cacheList: CacheList[];
-	private curSizeInBytes: number;
-	private maxPriority: number;
-
-	/**
-	 * initialize the cache
-	 *
-	 * @param config - the configuration of the cache
-	 */
-	constructor(config?: CacheConfig) {
-		super(config);
-
-		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 (let i = 0; i < this.maxPriority; i += 1) {
-			this.cacheList[i] = new CacheList();
-		}
-	}
-
-	/**
-	 * decrease current size of the cache
-	 *
-	 * @param amount - the amount of the cache size which needs to be decreased
-	 */
-	private _decreaseCurSizeInBytes(amount: number): void {
-		this.curSizeInBytes -= amount;
-	}
-
-	/**
-	 * increase current size of the cache
-	 *
-	 * @param amount - the amount of the cache szie which need to be increased
-	 */
-	private _increaseCurSizeInBytes(amount: number): void {
-		this.curSizeInBytes += amount;
-	}
-
-	/**
-	 * check whether item is expired
-	 *
-	 * @param key - the key of the item
-	 *
-	 * @return true if the item is expired.
-	 */
-	private _isExpired(key: string): boolean {
-		const text: string | null = CacheObject.getItem(key);
-
-		asserts(text !== null, {
-			name: STORAGE_CACHE_EXCEPTION,
-			message: 'item from storage is null',
-		});
-		const item: CacheItem = JSON.parse(text);
-		if (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
-	 */
-	private _removeItem(prefixedKey: string, listIdx: number): void {
-		// delete the key from the list
-		this.cacheList[listIdx].removeItem(prefixedKey);
-		// decrease the current size of the cache
-		const item = CacheObject.getItem(prefixedKey);
-		asserts(item !== null, {
-			name: STORAGE_CACHE_EXCEPTION,
-			message: 'item from storage is null',
-		});
-		this._decreaseCurSizeInBytes(JSON.parse(item).byteSize);
-		// finally remove the item from memory
-		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
-	 */
-	private _setItem(
-		prefixedKey: string,
-		item: CacheItem,
-		listIdx: number
-	): void {
-		// 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
-		CacheObject.setItem(prefixedKey, JSON.stringify(item));
-	}
-
-	/**
-	 * see whether cache is full
-	 *
-	 * @param itemSize
-	 *
-	 * @return true if cache is full
-	 */
-	private _isCacheFull(itemSize: number): boolean {
-		return this.curSizeInBytes + itemSize > this.cacheConfig.capacityInBytes;
-	}
-
-	/**
-	 * check whether the cache contains the key
-	 *
-	 * @param key
-	 */
-	private containsKey(key: string): number {
-		const prefixedKey: string = this.cacheConfig.keyPrefix + key;
-		for (let 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
-	 */
-	public setItem(
-		key: string,
-		value: object | string | number | boolean,
-		options?: CacheItemOptions
-	): void {
-		const prefixedKey: string = this.cacheConfig.keyPrefix + key;
-		// invalid keys
-		if (
-			prefixedKey === this.cacheConfig.keyPrefix ||
-			prefixedKey === 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;
-		}
-
-		const cacheItemOptions = {
-			priority:
-				options && options.priority !== undefined
-					? options.priority
-					: this.cacheConfig.defaultPriority,
-			expires:
-				options && options.expires !== undefined
-					? options.expires
-					: this.cacheConfig.defaultTTL + 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;
-		}
-
-		const item: CacheItem = this.fillCacheItem(
-			prefixedKey,
-			value,
-			cacheItemOptions
-		);
-
-		// check wether this item is too big;
-		if (item.byteSize > this.cacheConfig.itemMaxSize) {
-			logger.warn(
-				`Item with key: ${key} you are trying to put into is too big!`
-			);
-			return;
-		}
-
-		// if key already in the cache, then delete it.
-		const presentKeyPrio: number = 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
-		let cacheListIdx = this.maxPriority - 1;
-		while (this._isCacheFull(item.byteSize) && cacheListIdx >= 0) {
-			if (!this.cacheList[cacheListIdx].isEmpty()) {
-				const 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
-	 */
-	public getItem(key: string, options?: CacheItemOptions): any {
-		let ret: string | null = null;
-		const prefixedKey: string = this.cacheConfig.keyPrefix + key;
-
-		if (
-			prefixedKey === this.cacheConfig.keyPrefix ||
-			prefixedKey === getCurrSizeKey(this.cacheConfig.keyPrefix)
-		) {
-			logger.warn(`Invalid key: should not be empty or 'CurSize'`);
-			return null;
-		}
-
-		// check whether it's in the cachelist
-		const presentKeyPrio: number = 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 = CacheObject.getItem(prefixedKey) ?? '';
-				const item: CacheItem = JSON.parse(ret);
-				this.cacheList[item.priority - 1].refresh(prefixedKey);
-				return item.data;
-			}
-		}
-
-		if (options && options.callback !== undefined) {
-			const val: object | string | number | boolean = 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
-	 */
-	public removeItem(key: string): void {
-		const prefixedKey: string = this.cacheConfig.keyPrefix + key;
-
-		// check if the key is in the cache
-		const presentKeyPrio: number = this.containsKey(key);
-		if (presentKeyPrio !== -1) {
-			this._removeItem(prefixedKey, presentKeyPrio - 1);
-		}
-	}
-
-	/**
-	 * clear the entire cache
-	 */
-	public clear(): void {
-		for (let i = 0; i < this.maxPriority; i += 1) {
-			for (const key of this.cacheList[i].getKeys()) {
-				this._removeItem(key, i);
-			}
-		}
-	}
-
-	/**
-	 * Return all the keys in the cache.
-	 */
-	public getAllKeys(): string[] {
-		const keys: string[] = [];
-		for (let i = 0; i < this.maxPriority; i += 1) {
-			for (const key of this.cacheList[i].getKeys()) {
-				keys.push(key.substring(this.cacheConfig.keyPrefix.length));
-			}
-		}
-
-		return keys;
-	}
-
-	/**
-	 * return the current size of the cache
-	 *
-	 * @return the current size of the cache
-	 */
-	public getCacheCurSize(): number {
-		return this.curSizeInBytes;
-	}
-
-	/**
-	 * Return a new instance of cache with customized configuration.
-	 * @param config - the customized configuration
-	 */
-	public createInstance(config: CacheConfig): ICache {
-		return new InMemoryCacheClass(config);
-	}
-}
-
-export const InMemoryCache: ICache = new InMemoryCacheClass();

package/src/Cache/Utils/CacheUtils.ts

@@ -1,92 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import { CacheConfig } from '../types';
-import { StorageHelper } from '../../StorageHelper';
-/**
- * Default cache config
- */
-export const defaultConfig: CacheConfig = {
-	keyPrefix: 'aws-amplify-cache',
-	capacityInBytes: 1048576, // 1MB
-	itemMaxSize: 210000, // about 200kb
-	defaultTTL: 259200000, // about 3 days
-	defaultPriority: 5,
-	warningThreshold: 0.8,
-	// the storage helper will check if localStorage exists,
-	// if not, will use a in-memory object instead
-	storage: new StorageHelper().getStorage(),
-};
-
-/**
- * return the byte size of the string
- * @param str
- */
-export function getByteLength(str: string): number {
-	let ret: number = 0;
-	ret = str.length;
-
-	for (let i = str.length; i >= 0; i -= 1) {
-		const charCode: number = str.charCodeAt(i);
-		if (charCode > 0x7f && charCode <= 0x7ff) {
-			ret += 1;
-		} else if (charCode > 0x7ff && charCode <= 0xffff) {
-			ret += 2;
-		}
-		// trail surrogate
-		if (charCode >= 0xdc00 && charCode <= 0xdfff) {
-			i -= 1;
-		}
-	}
-
-	return ret;
-}
-
-/**
- * get current time
- */
-export function getCurrTime(): number {
-	const currTime = new Date();
-	return currTime.getTime();
-}
-
-/**
- * check if passed value is an integer
- */
-export function isInteger(value?: number): boolean {
-	if (Number.isInteger) {
-		return Number.isInteger(value);
-	}
-
-	return _isInteger(value);
-}
-
-function _isInteger(value?: number): boolean {
-	return (
-		typeof value === 'number' && isFinite(value) && Math.floor(value) === value
-	);
-}
-
-/**
- * provide an object as the in-memory cache
- */
-let store: Record<string, string> = {};
-export class CacheObject {
-	static clear(): void {
-		store = {};
-	}
-
-	static getItem(key: string): string | null {
-		return store[key] || null;
-	}
-
-	static setItem(key: string, value: string): void {
-		store[key] = value;
-	}
-
-	static removeItem(key: string): void {
-		delete store[key];
-	}
-}
-
-export const getCurrSizeKey = (keyPrefix: string) => keyPrefix + 'CurSize';

package/src/Cache/reactnative.ts

@@ -1,9 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import { Cache, AsyncStorageCache } from './AsyncStorageCache';
-
-export { AsyncStorageCache };
-
-// Standard `Cache` export to maintain interoperability with React Native
-export { Cache };

package/src/Cache/types/Cache.ts

@@ -1,75 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.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/src/ClientDevice/index.ts

@@ -1,14 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import { clientInfo, dimension } from './browser';
-
-export class ClientDevice {
-	static clientInfo() {
-		return clientInfo();
-	}
-
-	static dimension() {
-		return dimension();
-	}
-}

package/src/ClientDevice/reactnative.ts

@@ -1,18 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-// @ts-ignore: missing type definition
-import { Platform } from 'react-native';
-import { clientInfo as iOSClientInfo } from './ios';
-import { clientInfo as androidClientInfo } from './android';
-
-const { OS } = Platform;
-
-export class ClientDevice {
-	static clientInfo() {
-		if (OS === 'ios') {
-			return iOSClientInfo();
-		} else {
-			return androidClientInfo();
-		}
-	}
-}

package/src/RNComponents/index.ts

@@ -1,16 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import { isBrowser } from '../Util/JS';
-import { StorageHelper } from '../StorageHelper';
-
-export const Linking = {};
-export const AppState = {
-	addEventListener: (action: any, handler: any) => undefined,
-	currentState: 'active',
-};
-
-// if not in react native, just use local storage
-export const AsyncStorage = isBrowser()
-	? new StorageHelper().getStorage()
-	: undefined;

package/src/RNComponents/isAppInForeground.ts

@@ -1,8 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import { AppState } from '.';
-
-export const isAppInForeground = () => {
-	return AppState.currentState === 'active';
-};

package/src/RNComponents/reactnative.ts

@@ -1,6 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-// @ts-ignore
-import { Linking, AppState } from 'react-native';
-import AsyncStorage from '@react-native-async-storage/async-storage';
-export { Linking, AppState, AsyncStorage };

package/src/StorageHelper/cookieStorage.ts

@@ -1,99 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-// @ts-ignore
-import * as Cookies from 'js-cookie';
-import {
-	CookieStorageData,
-	KeyValueStorageInterface,
-	SameSite,
-} from '../types';
-
-export class CookieStorage implements KeyValueStorageInterface {
-	domain?: string;
-	path: string;
-	expires?: number; // days;
-	secure?: boolean;
-	sameSite?: SameSite;
-
-	constructor(data: CookieStorageData = {}) {
-		if (data.domain) {
-			this.domain = data.domain;
-		}
-		if (data.path) {
-			this.path = data.path;
-		} else {
-			this.path = '/';
-		}
-		if (Object.prototype.hasOwnProperty.call(data, 'expires')) {
-			this.expires = data.expires;
-		} else {
-			this.expires = 365;
-		}
-		if (Object.prototype.hasOwnProperty.call(data, 'secure')) {
-			this.secure = data.secure;
-		} else {
-			this.secure = true;
-		}
-		if (data.hasOwnProperty('sameSite')) {
-			if (
-				!data.sameSite ||
-				!['strict', 'lax', 'none'].includes(data.sameSite)
-			) {
-				throw new Error(
-					'The sameSite value of cookieStorage must be "lax", "strict" or "none".'
-				);
-			}
-			if (data.sameSite === 'none' && !this.secure) {
-				throw new Error(
-					'sameSite = None requires the Secure attribute in latest browser versions.'
-				);
-			}
-			this.sameSite = data.sameSite;
-		}
-	}
-
-	async setItem(key: string, value: string): Promise<void> {
-		const options: CookieStorageData = {
-			path: this.path,
-			expires: this.expires,
-			domain: this.domain,
-			secure: this.secure,
-		};
-
-		if (this.sameSite) {
-			options.sameSite = this.sameSite;
-		}
-
-		Cookies.set(key, value, options);
-		return Cookies.get(key);
-	}
-
-	async getItem(key: string): Promise<string> {
-		return Cookies.get(key);
-	}
-
-	async removeItem(key: string): Promise<void> {
-		const options: CookieStorageData = {
-			path: this.path,
-			expires: this.expires,
-			domain: this.domain,
-			secure: this.secure,
-		};
-
-		if (this.sameSite) {
-			options.sameSite = this.sameSite;
-		}
-
-		Cookies.remove(key, options);
-	}
-
-	async clear(): Promise<void> {
-		const cookies = Cookies.get();
-		const numKeys = Object.keys(cookies).length;
-		const promiseArray: Promise<void>[] = [];
-		for (let index = 0; index < numKeys; ++index) {
-			promiseArray.push(this.removeItem(Object.keys(cookies)[index]));
-		}
-		await Promise.all(promiseArray);
-	}
-}