@aws-amplify/core 6.0.17-unstable.e316a2e.0 → 6.0.17

package/src/Cache/StorageCache.native.ts

@@ -2,7 +2,9 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { loadAsyncStorage } from '@aws-amplify/react-native';
+
 import { ConsoleLogger } from '../Logger';
+
 import { defaultConfig } from './constants';
 import { StorageCacheCommon } from './StorageCacheCommon';
 import { Cache, CacheConfig } from './types';
@@ -38,6 +40,7 @@ export class StorageCache extends StorageCacheCommon implements Cache {
 				keys.push(key.substring(this.config.keyPrefix.length));
 			}
 		}
+
 		return keys;
 	}
 
@@ -46,6 +49,7 @@ export class StorageCache extends StorageCacheCommon implements Cache {
 			return AsyncStorage.getAllKeys();
 		} catch (e) {
 			logger.warn(`getAllKeys failed! ${e}`);
+
 			return [];
 		}
 	}
@@ -60,6 +64,7 @@ export class StorageCache extends StorageCacheCommon implements Cache {
 			logger.error('invalid keyPrefix, setting keyPrefix with timeStamp');
 			config.keyPrefix = getCurrentTime.toString();
 		}
+
 		return new StorageCache(config);
 	}
 }

package/src/Cache/StorageCache.ts

@@ -4,6 +4,7 @@
 import { ConsoleLogger } from '../Logger';
 import { KeyValueStorage } from '../storage/KeyValueStorage';
 import { getLocalStorageWithFallback } from '../storage/utils';
+
 import { defaultConfig } from './constants';
 import { StorageCacheCommon } from './StorageCacheCommon';
 import { Cache, CacheConfig } from './types';
@@ -42,6 +43,7 @@ export class StorageCache extends StorageCacheCommon implements Cache {
 				keys.push(key.substring(this.config.keyPrefix.length));
 			}
 		}
+
 		return keys;
 	}
 

package/src/Cache/StorageCacheCommon.ts

@@ -3,10 +3,11 @@
 
 import { ConsoleLogger } from '../Logger';
 import { KeyValueStorageInterface } from '../types';
+
 import { currentSizeKey, defaultConfig } from './constants';
 import { CacheConfig, CacheItem, CacheItemOptions } from './types';
-import { getCurrentSizeKey, getCurrentTime, getByteLength } from './utils';
-import { assert, CacheErrorCode } from './utils/errorHelpers';
+import { getByteLength, getCurrentSizeKey, getCurrentTime } from './utils';
+import { CacheErrorCode, assert } from './utils/errorHelpers';
 
 const logger = new ConsoleLogger('StorageCache');
 
@@ -58,7 +59,7 @@ export abstract class StorageCacheCommon {
 		if (config) {
 			if ((config as CacheConfig).keyPrefix) {
 				logger.warn(
-					'keyPrefix can not be re-configured on an existing Cache instance.'
+					'keyPrefix can not be re-configured on an existing Cache instance.',
 				);
 			}
 
@@ -79,15 +80,16 @@ export abstract class StorageCacheCommon {
 	 */
 	public async getCurrentCacheSize() {
 		let size = await this.getStorage().getItem(
-			getCurrentSizeKey(this.config.keyPrefix)
+			getCurrentSizeKey(this.config.keyPrefix),
 		);
 		if (!size) {
 			await this.getStorage().setItem(
 				getCurrentSizeKey(this.config.keyPrefix),
-				'0'
+				'0',
 			);
 			size = '0';
 		}
+
 		return Number(size);
 	}
 
@@ -112,21 +114,23 @@ export abstract class StorageCacheCommon {
 	public async setItem(
 		key: string,
 		value: any,
-		options?: Record<string, any>
+		options?: Record<string, any>,
 	): Promise<void> {
 		logger.debug(
-			`Set item: key is ${key}, value is ${value} with options: ${options}`
+			`Set item: key is ${key}, value is ${value} with options: ${options}`,
 		);
 
 		if (!key || key === currentSizeKey) {
 			logger.warn(
-				`Invalid key: should not be empty or reserved key: '${currentSizeKey}'`
+				`Invalid key: should not be empty or reserved key: '${currentSizeKey}'`,
 			);
+
 			return;
 		}
 
 		if (typeof value === 'undefined') {
 			logger.warn(`The value of item should not be undefined!`);
+
 			return;
 		}
 
@@ -143,8 +147,9 @@ export abstract class StorageCacheCommon {
 
 		if (cacheItemOptions.priority < 1 || cacheItemOptions.priority > 5) {
 			logger.warn(
-				`Invalid parameter: priority due to out or range. It should be within 1 and 5.`
+				`Invalid parameter: priority due to out or range. It should be within 1 and 5.`,
 			);
+
 			return;
 		}
 
@@ -154,8 +159,9 @@ export abstract class StorageCacheCommon {
 		// check whether this item is too big;
 		if (item.byteSize > this.config.itemMaxSize) {
 			logger.warn(
-				`Item with key: ${key} you are trying to put into is too big!`
+				`Item with key: ${key} you are trying to put into is too big!`,
 			);
+
 			return;
 		}
 
@@ -174,6 +180,7 @@ export abstract class StorageCacheCommon {
 					await this.popOutItems(validKeys, sizeToPop);
 				}
 			}
+
 			// put item in the cache
 			return this.setCacheItem(prefixedKey, item);
 		} catch (e) {
@@ -198,15 +205,16 @@ export abstract class StorageCacheCommon {
 	 */
 	public async getItem(
 		key: string,
-		options?: CacheItemOptions
+		options?: CacheItemOptions,
 	): Promise<CacheItem['data']> {
 		logger.debug(`Get item: key is ${key} with options ${options}`);
 		let cached;
 
 		if (!key || key === currentSizeKey) {
 			logger.warn(
-				`Invalid key: should not be empty or reserved key: '${currentSizeKey}'`
+				`Invalid key: should not be empty or reserved key: '${currentSizeKey}'`,
 			);
+
 			return null;
 		}
 
@@ -222,8 +230,9 @@ export abstract class StorageCacheCommon {
 					// if not expired, update its visitedTime and return the value
 					const item = await this.updateVisitedTime(
 						JSON.parse(cached),
-						prefixedKey
+						prefixedKey,
 					);
+
 					return item.data;
 				}
 			}
@@ -233,11 +242,14 @@ export abstract class StorageCacheCommon {
 				if (val !== null) {
 					await this.setItem(key, val, options);
 				}
+
 				return val;
 			}
+
 			return null;
 		} catch (e) {
 			logger.warn(`getItem failed! ${e}`);
+
 			return null;
 		}
 	}
@@ -254,8 +266,9 @@ export abstract class StorageCacheCommon {
 
 		if (!key || key === currentSizeKey) {
 			logger.warn(
-				`Invalid key: should not be empty or reserved key: '${currentSizeKey}'`
+				`Invalid key: should not be empty or reserved key: '${currentSizeKey}'`,
 			);
+
 			return;
 		}
 
@@ -282,6 +295,7 @@ export abstract class StorageCacheCommon {
 			return await this.getAllCacheKeys();
 		} catch (e) {
 			logger.warn(`getAllkeys failed! ${e}`);
+
 			return [];
 		}
 	}
@@ -304,6 +318,7 @@ export abstract class StorageCacheCommon {
 		if (getCurrentTime() >= item.expires) {
 			return true;
 		}
+
 		return false;
 	}
 
@@ -315,7 +330,7 @@ export abstract class StorageCacheCommon {
 	 */
 	protected async removeCacheItem(
 		prefixedKey: string,
-		size?: number
+		size?: number,
 	): Promise<void> {
 		const item = await this.getStorage().getItem(prefixedKey);
 		assert(item !== null, CacheErrorCode.NoCacheItem, `Key: ${prefixedKey}`);
@@ -343,7 +358,7 @@ export abstract class StorageCacheCommon {
 	protected fillCacheItem(
 		key: string,
 		value: object | number | string | boolean,
-		options: CacheItemOptions
+		options: CacheItemOptions,
 	): CacheItem {
 		const item: CacheItem = {
 			key,
@@ -359,20 +374,21 @@ export abstract class StorageCacheCommon {
 		item.byteSize = getByteLength(JSON.stringify(item));
 		// re-calculate using cache item with updated byteSize property
 		item.byteSize = getByteLength(JSON.stringify(item));
+
 		return item;
 	}
 
 	private sanitizeConfig(): void {
 		if (this.config.itemMaxSize > this.config.capacityInBytes) {
 			logger.error(
-				'Invalid parameter: itemMaxSize. It should be smaller than capacityInBytes. Setting back to default.'
+				'Invalid parameter: itemMaxSize. It should be smaller than capacityInBytes. Setting back to default.',
 			);
 			this.config.itemMaxSize = defaultConfig.itemMaxSize;
 		}
 
 		if (this.config.defaultPriority > 5 || this.config.defaultPriority < 1) {
 			logger.error(
-				'Invalid parameter: defaultPriority. It should be between 1 and 5. Setting back to default.'
+				'Invalid parameter: defaultPriority. It should be between 1 and 5. Setting back to default.',
 			);
 			this.config.defaultPriority = defaultConfig.defaultPriority;
 		}
@@ -382,7 +398,7 @@ export abstract class StorageCacheCommon {
 			Number(this.config.warningThreshold) < 0
 		) {
 			logger.error(
-				'Invalid parameter: warningThreshold. It should be between 0 and 1. Setting back to default.'
+				'Invalid parameter: warningThreshold. It should be between 0 and 1. Setting back to default.',
 			);
 			this.config.warningThreshold = defaultConfig.warningThreshold;
 		}
@@ -391,7 +407,7 @@ export abstract class StorageCacheCommon {
 		const cacheLimit: number = 5 * 1024 * 1024;
 		if (this.config.capacityInBytes > cacheLimit) {
 			logger.error(
-				'Cache Capacity should be less than 5MB. Setting back to default. Setting back to default.'
+				'Cache Capacity should be less than 5MB. Setting back to default. Setting back to default.',
 			);
 			this.config.capacityInBytes = defaultConfig.capacityInBytes;
 		}
@@ -406,7 +422,7 @@ export abstract class StorageCacheCommon {
 		const size = await this.getCurrentCacheSize();
 		await this.getStorage().setItem(
 			getCurrentSizeKey(this.config.keyPrefix),
-			(size + amount).toString()
+			(size + amount).toString(),
 		);
 	}
 
@@ -419,7 +435,7 @@ export abstract class StorageCacheCommon {
 		const size = await this.getCurrentCacheSize();
 		await this.getStorage().setItem(
 			getCurrentSizeKey(this.config.keyPrefix),
-			(size - amount).toString()
+			(size - amount).toString(),
 		);
 	}
 
@@ -433,10 +449,11 @@ export abstract class StorageCacheCommon {
 	 */
 	private async updateVisitedTime(
 		item: CacheItem,
-		prefixedKey: string
+		prefixedKey: string,
 	): Promise<CacheItem> {
 		item.visitedTime = getCurrentTime();
 		await this.getStorage().setItem(prefixedKey, JSON.stringify(item));
+
 		return item;
 	}
 
@@ -449,7 +466,7 @@ export abstract class StorageCacheCommon {
 	 */
 	private async setCacheItem(
 		prefixedKey: string,
-		item: CacheItem
+		item: CacheItem,
 	): Promise<void> {
 		// first try to update the current size of the cache.
 		await this.increaseCurrentSizeInBytes(item.byteSize);
@@ -476,6 +493,7 @@ export abstract class StorageCacheCommon {
 		const spaceItemNeed = cur + itemSize - this.config.capacityInBytes;
 		const cacheThresholdSpace =
 			(1 - this.config.warningThreshold) * this.config.capacityInBytes;
+
 		return spaceItemNeed > cacheThresholdSpace
 			? spaceItemNeed
 			: cacheThresholdSpace;
@@ -490,6 +508,7 @@ export abstract class StorageCacheCommon {
 	 */
 	private async isCacheFull(itemSize: number): Promise<boolean> {
 		const cur = await this.getCurrentCacheSize();
+
 		return itemSize + cur > this.config.capacityInBytes;
 	}
 
@@ -504,8 +523,8 @@ export abstract class StorageCacheCommon {
 	private async popOutItems(keys: string[], sizeToPop: number): Promise<void> {
 		const items: any[] = [];
 		let remainedSize = sizeToPop;
-		for (let i = 0; i < keys.length; i += 1) {
-			const val = await this.getStorage().getItem(keys[i]);
+		for (const key of keys) {
+			const val = await this.getStorage().getItem(key);
 			if (val != null) {
 				const item = JSON.parse(val);
 				items.push(item);
@@ -526,10 +545,10 @@ export abstract class StorageCacheCommon {
 			}
 		});
 
-		for (let i = 0; i < items.length; i += 1) {
+		for (const item of items) {
 			// pop out items until we have enough room for new item
-			await this.removeCacheItem(items[i].key, items[i].byteSize);
-			remainedSize -= items[i].byteSize;
+			await this.removeCacheItem(item.key, item.byteSize);
+			remainedSize -= item.byteSize;
 			if (remainedSize <= 0) {
 				return;
 			}
@@ -555,6 +574,7 @@ export abstract class StorageCacheCommon {
 				remainingKeys.push(key);
 			}
 		}
+
 		return remainingKeys;
 	}
 

package/src/Cache/types/cache.ts

@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { CacheConfig } from '../../singleton/Cache/types';
+
 export { CacheConfig };
 
 /**
@@ -47,5 +48,5 @@ export interface CacheItem {
 export interface CacheItemOptions {
 	priority?: number;
 	expires?: number;
-	callback?: Function;
+	callback?(): unknown;
 }

package/src/Cache/utils/CacheList.ts

@@ -1,7 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { assert, CacheErrorCode } from './errorHelpers';
+import { CacheErrorCode, assert } from './errorHelpers';
 
 class DoubleLinkedNode {
 	key: string;
@@ -9,7 +9,7 @@ class DoubleLinkedNode {
 	nextNode: DoubleLinkedNode | null;
 
 	constructor(keyVal?: string) {
-		this.key = keyVal ? keyVal : '';
+		this.key = keyVal || '';
 		this.prevNode = null;
 		this.nextNode = null;
 	}
@@ -112,6 +112,7 @@ export class CacheList {
 	 */
 	public getLastItem(): string {
 		assert(this.tail.prevNode !== null, CacheErrorCode.NullPreviousNode);
+
 		return this.tail.prevNode.key;
 	}
 
@@ -145,7 +146,7 @@ export class CacheList {
 	 */
 	public clearList(): void {
 		for (const key of Object.keys(this.hashtable)) {
-			if (this.hashtable.hasOwnProperty(key)) {
+			if (Object.prototype.hasOwnProperty.call(this.hashtable, key)) {
 				delete this.hashtable[key];
 			}
 		}
@@ -169,6 +170,7 @@ export class CacheList {
 	 */
 	public isHeadNode(key: string): boolean {
 		const node = this.hashtable[key];
+
 		return node.prevNode === this.head;
 	}
 
@@ -180,6 +182,7 @@ export class CacheList {
 	 */
 	public isTailNode(key: string): boolean {
 		const node = this.hashtable[key];
+
 		return node.nextNode === this.tail;
 	}
 }

package/src/Cache/utils/cacheHelpers.ts

@@ -8,7 +8,7 @@ import { currentSizeKey } from '../constants';
  * @param str
  */
 export function getByteLength(str: string): number {
-	let ret: number = 0;
+	let ret = 0;
 	ret = str.length;
 
 	for (let i = str.length; i >= 0; i -= 1) {
@@ -32,6 +32,7 @@ export function getByteLength(str: string): number {
  */
 export function getCurrentTime(): number {
 	const currentTime = new Date();
+
 	return currentTime.getTime();
 }
 

package/src/Hub/index.ts

@@ -4,6 +4,7 @@
 import { ConsoleLogger } from '../Logger';
 import { NO_HUBCALLBACK_PROVIDED_EXCEPTION } from '../constants';
 import { AmplifyError } from '../errors';
+
 import {
 	AmplifyChannel,
 	AmplifyEventData,
@@ -19,7 +20,7 @@ export const AMPLIFY_SYMBOL = (
 	typeof Symbol !== 'undefined'
 		? Symbol('amplify_default')
 		: '@@amplify_default'
-) as Symbol;
+) as symbol;
 
 const logger = new ConsoleLogger('Hub');
 
@@ -56,6 +57,7 @@ export class HubClass {
 		const holder = this.listeners.get(channel);
 		if (!holder) {
 			logger.warn(`No listeners for ${channel}`);
+
 			return;
 		}
 		this.listeners.set(channel, [
@@ -77,14 +79,14 @@ export class HubClass {
 		channel: Channel,
 		payload: HubPayload<AmplifyEventData[Channel]>,
 		source?: string,
-		ampSymbol?: Symbol
+		ampSymbol?: symbol,
 	): void;
 
 	dispatch(
 		channel: string,
 		payload: HubPayload,
 		source?: string,
-		ampSymbol?: Symbol
+		ampSymbol?: symbol,
 	): void;
 
 	dispatch<
@@ -94,7 +96,7 @@ export class HubClass {
 		channel: Channel | string,
 		payload: HubPayload<EventData>,
 		source?: string,
-		ampSymbol?: Symbol
+		ampSymbol?: symbol,
 	): void {
 		if (
 			typeof channel === 'string' &&
@@ -104,7 +106,7 @@ export class HubClass {
 
 			if (!hasAccess) {
 				logger.warn(
-					`WARNING: ${channel} is protected and dispatching on it can have unintended consequences`
+					`WARNING: ${channel} is protected and dispatching on it can have unintended consequences`,
 				);
 			}
 		}
@@ -132,19 +134,16 @@ export class HubClass {
 	 * @returns A function which can be called to cancel the listener.
 	 *
 	 */
-	listen<
-		Channel extends AmplifyChannel,
-		EventData extends EventDataMap = EventDataMap,
-	>(
+	listen<Channel extends AmplifyChannel>(
 		channel: Channel,
 		callback: HubCallback<Channel, AmplifyEventData[Channel]>,
-		listenerName?: string
+		listenerName?: string,
 	): StopListenerCallback;
 
 	listen<EventData extends EventDataMap>(
 		channel: string,
 		callback: HubCallback<string, EventData>,
-		listenerName?: string
+		listenerName?: string,
 	): StopListenerCallback;
 
 	listen<
@@ -153,7 +152,7 @@ export class HubClass {
 	>(
 		channel: Channel,
 		callback: HubCallback<Channel, EventData>,
-		listenerName: string = 'noname'
+		listenerName = 'noname',
 	): StopListenerCallback {
 		let cb: HubCallback<string, EventDataMap>;
 		if (typeof callback !== 'function') {
@@ -176,13 +175,14 @@ export class HubClass {
 			name: listenerName,
 			callback: cb,
 		});
+
 		return () => {
 			this._remove(channel, cb);
 		};
 	}
 
 	private _toListeners<Channel extends AmplifyChannel | string>(
-		capsule: HubCapsule<Channel, EventDataMap | AmplifyEventData[Channel]>
+		capsule: HubCapsule<Channel, EventDataMap | AmplifyEventData[Channel]>,
 	) {
 		const { channel, payload } = capsule;
 		const holder = this.listeners.get(channel);
@@ -199,9 +199,9 @@ export class HubClass {
 	}
 }
 
-/*We export a __default__ instance of HubClass to use it as a 
+/* We export a __default__ instance of HubClass to use it as a
 pseudo Singleton for the main messaging bus, however you can still create
-your own instance of HubClass() for a separate "private bus" of events.*/
+your own instance of HubClass() for a separate "private bus" of events. */
 export const Hub = new HubClass('__default__');
 
 /**

package/src/Hub/types/AuthTypes.ts

@@ -1,30 +1,30 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-type AuthUser = {
+interface AuthUser {
 	username: string;
 	userId: string;
-};
-type AuthError = {
+}
+interface AuthError {
 	name: string;
 	message: string;
 	recoverySuggestion?: string;
-};
+}
 export type AuthHubEventData =
-	/** Dispatched when a user signs in with an oauth provider such as Google.*/
+	/** Dispatched when a user signs in with an oauth provider such as Google. */
 	| { event: 'signInWithRedirect' }
-	/** Dispatched when there is an error in the oauth flow process.*/
+	/** Dispatched when there is an error in the oauth flow process. */
 	| {
 			event: 'signInWithRedirect_failure';
 			data: { error?: AuthError };
 	  }
-	/** Dispatched when auth tokens are successfully refreshed.*/
+	/** Dispatched when auth tokens are successfully refreshed. */
 	| { event: 'tokenRefresh' }
-	/** Dispatched when there is an error in the refresh of tokens.*/
+	/** Dispatched when there is an error in the refresh of tokens. */
 	| { event: 'tokenRefresh_failure'; data: { error?: AuthError } }
-	/** Dispatched when there is a customState passed in the options of the `signInWithRedirect` API.*/
+	/** Dispatched when there is a customState passed in the options of the `signInWithRedirect` API. */
 	| { event: 'customOAuthState'; data: string }
-	/** Dispatched when the user is signed-in.*/
+	/** Dispatched when the user is signed-in. */
 	| { event: 'signedIn'; data: AuthUser }
-	/** Dispatched after the user calls the `signOut` API successfully.*/
+	/** Dispatched after the user calls the `signOut` API successfully. */
 	| { event: 'signedOut' };

package/src/Hub/types/HubTypes.ts

@@ -11,25 +11,28 @@ export type IListener<
 	callback: HubCallback<Channel, EventData>;
 }[];
 
-export type EventDataMap = { event: string; data?: unknown };
+export interface EventDataMap {
+	event: string;
+	data?: unknown;
+}
 
-export type AmplifyEventData = {
+export interface AmplifyEventData {
 	auth: AuthHubEventData;
 	[key: string]: EventDataMap;
-};
+}
 export type AmplifyChannel = 'auth';
 
 export type StopListenerCallback = () => void;
 
-export type HubCapsule<
+export interface HubCapsule<
 	Channel extends string,
 	EventData extends EventDataMap,
-> = {
+> {
 	channel: Channel;
 	payload: HubPayload<EventData>;
 	source?: string;
 	patternInfo?: string[];
-};
+}
 
 export type HubCallback<
 	Channel extends string = string,
@@ -41,6 +44,6 @@ export type HubPayload<EventData extends EventDataMap = EventDataMap> =
 		message?: string;
 	};
 
-export type AmplifyHubCallbackMap<Channel extends AmplifyChannel> = {
+export interface AmplifyHubCallbackMap<Channel extends AmplifyChannel> {
 	auth: HubCallback<Channel>;
-};
+}