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

package/src/Cache/{Utils → utils}/CacheList.ts

@@ -1,198 +1,185 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import { asserts } from '../../Util/errors/AssertError';
-import { CACHE_LIST_EXCEPTION } from '../../Util/Constants';
-
-class DoubleLinkedNode {
-	key: string;
-	prevNode: DoubleLinkedNode | null;
-	nextNode: DoubleLinkedNode | null;
-
-	constructor(keyVal?: string) {
-		this.key = keyVal ? keyVal : '';
-		this.prevNode = null;
-		this.nextNode = null;
-	}
-}
-
-/**
- * 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: DoubleLinkedNode;
-	private tail: DoubleLinkedNode;
-	private hashtable: Record<string, any>;
-	private length: number;
-
-	/**
-	 * initialization
-	 */
-	constructor() {
-		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
-	 */
-	private insertNodeToHead(node: DoubleLinkedNode) {
-		const tmp: DoubleLinkedNode | null = this.head.nextNode;
-		this.head.nextNode = node;
-		node.nextNode = tmp;
-		node.prevNode = this.head;
-		asserts(tmp !== null, {
-			name: CACHE_LIST_EXCEPTION,
-			message: 'previous node is null',
-		});
-		tmp.prevNode = node;
-
-		this.length = this.length + 1;
-	}
-
-	/**
-	 * remove node
-	 *
-	 * @param node
-	 */
-	private removeNode(node: DoubleLinkedNode): void {
-		asserts(node.prevNode !== null, {
-			name: CACHE_LIST_EXCEPTION,
-			message: 'previous node is null',
-		});
-		asserts(node.nextNode !== null, {
-			name: 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
-	 */
-	public isEmpty(): boolean {
-		return this.length === 0;
-	}
-
-	/**
-	 * refresh node so it is rotated to the head
-	 *
-	 * @param key - key of the node
-	 */
-	public refresh(key: string): void {
-		const node: DoubleLinkedNode = 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
-	 */
-	public insertItem(key: string): void {
-		const node: DoubleLinkedNode = new DoubleLinkedNode(key);
-		this.hashtable[key] = node;
-		this.insertNodeToHead(node);
-	}
-
-	/**
-	 * @return the LAST Recently Visited key
-	 */
-	public getLastItem(): string {
-		asserts(this.tail.prevNode !== null, {
-			name: 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
-	 */
-	public removeItem(key: string): void {
-		const removedItem: DoubleLinkedNode = this.hashtable[key];
-		this.removeNode(removedItem);
-		delete this.hashtable[key];
-	}
-
-	/**
-	 * @return length of the list
-	 */
-	public getSize(): number {
-		return this.length;
-	}
-
-	/**
-	 * @return true if the key is in the hashtable
-	 * @param key
-	 */
-	public containsKey(key: string): boolean {
-		return key in this.hashtable;
-	}
-
-	/**
-	 * clean up the list and hashtable
-	 */
-	public clearList(): void {
-		for (const key of Object.keys(this.hashtable)) {
-			if (this.hashtable.hasOwnProperty(key)) {
-				delete this.hashtable[key];
-			}
-		}
-		this.head.nextNode = this.tail;
-		this.tail.prevNode = this.head;
-		this.length = 0;
-	}
-
-	/**
-	 * @return all keys in the hashtable
-	 */
-	public getKeys(): string[] {
-		return Object.keys(this.hashtable);
-	}
-
-	/**
-	 * mainly for test
-	 *
-	 * @param key
-	 * @return true if key is the head node
-	 */
-	public isHeadNode(key: string): boolean {
-		const node = this.hashtable[key];
-		return node.prevNode === this.head;
-	}
-
-	/**
-	 * mainly for test
-	 *
-	 * @param key
-	 * @return true if key is the tail node
-	 */
-	public isTailNode(key: string): boolean {
-		const node = this.hashtable[key];
-		return node.nextNode === this.tail;
-	}
-}
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { assert, CacheErrorCode } from './errorHelpers';
+
+class DoubleLinkedNode {
+	key: string;
+	prevNode: DoubleLinkedNode | null;
+	nextNode: DoubleLinkedNode | null;
+
+	constructor(keyVal?: string) {
+		this.key = keyVal ? keyVal : '';
+		this.prevNode = null;
+		this.nextNode = null;
+	}
+}
+
+/**
+ * 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 class CacheList {
+	private head: DoubleLinkedNode;
+	private tail: DoubleLinkedNode;
+	private hashtable: Record<string, any>;
+	private length: number;
+
+	/**
+	 * initialization
+	 */
+	constructor() {
+		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
+	 */
+	private insertNodeToHead(node: DoubleLinkedNode) {
+		const tmp: DoubleLinkedNode | null = this.head.nextNode;
+		this.head.nextNode = node;
+		node.nextNode = tmp;
+		node.prevNode = this.head;
+		assert(tmp !== null, CacheErrorCode.NullPreviousNode);
+		tmp.prevNode = node;
+
+		this.length = this.length + 1;
+	}
+
+	/**
+	 * remove node
+	 *
+	 * @param node
+	 */
+	private removeNode(node: DoubleLinkedNode): void {
+		assert(node.prevNode !== null, CacheErrorCode.NullPreviousNode);
+		assert(node.nextNode !== null, CacheErrorCode.NullNextNode);
+		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
+	 */
+	public isEmpty(): boolean {
+		return this.length === 0;
+	}
+
+	/**
+	 * refresh node so it is rotated to the head
+	 *
+	 * @param key - key of the node
+	 */
+	public refresh(key: string): void {
+		const node: DoubleLinkedNode = 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
+	 */
+	public insertItem(key: string): void {
+		const node: DoubleLinkedNode = new DoubleLinkedNode(key);
+		this.hashtable[key] = node;
+		this.insertNodeToHead(node);
+	}
+
+	/**
+	 * @return the LAST Recently Visited key
+	 */
+	public getLastItem(): string {
+		assert(this.tail.prevNode !== null, CacheErrorCode.NullPreviousNode);
+		return this.tail.prevNode.key;
+	}
+
+	/**
+	 * remove the cache key from the list and hashtable
+	 * @param key - the key of the node
+	 */
+	public removeItem(key: string): void {
+		const removedItem: DoubleLinkedNode = this.hashtable[key];
+		this.removeNode(removedItem);
+		delete this.hashtable[key];
+	}
+
+	/**
+	 * @return length of the list
+	 */
+	public getSize(): number {
+		return this.length;
+	}
+
+	/**
+	 * @return true if the key is in the hashtable
+	 * @param key
+	 */
+	public containsKey(key: string): boolean {
+		return key in this.hashtable;
+	}
+
+	/**
+	 * clean up the list and hashtable
+	 */
+	public clearList(): void {
+		for (const key of Object.keys(this.hashtable)) {
+			if (this.hashtable.hasOwnProperty(key)) {
+				delete this.hashtable[key];
+			}
+		}
+		this.head.nextNode = this.tail;
+		this.tail.prevNode = this.head;
+		this.length = 0;
+	}
+
+	/**
+	 * @return all keys in the hashtable
+	 */
+	public getKeys(): string[] {
+		return Object.keys(this.hashtable);
+	}
+
+	/**
+	 * mainly for test
+	 *
+	 * @param key
+	 * @return true if key is the head node
+	 */
+	public isHeadNode(key: string): boolean {
+		const node = this.hashtable[key];
+		return node.prevNode === this.head;
+	}
+
+	/**
+	 * mainly for test
+	 *
+	 * @param key
+	 * @return true if key is the tail node
+	 */
+	public isTailNode(key: string): boolean {
+		const node = this.hashtable[key];
+		return node.nextNode === this.tail;
+	}
+}

package/src/Cache/utils/cacheHelpers.ts

@@ -0,0 +1,52 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { currentSizeKey } from '../constants';
+
+/**
+ * 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 getCurrentTime(): number {
+	const currentTime = new Date();
+	return currentTime.getTime();
+}
+
+/**
+ * check if passed value is an integer
+ */
+export function isInteger(value?: number): boolean {
+	if (Number.isInteger) {
+		return Number.isInteger(value);
+	}
+
+	return (
+		typeof value === 'number' && isFinite(value) && Math.floor(value) === value
+	);
+}
+
+export const getCurrentSizeKey = (keyPrefix: string) =>
+	`${keyPrefix}${currentSizeKey}`;

package/src/Cache/utils/errorHelpers.ts

@@ -0,0 +1,26 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { createAssertionFunction } from '../../errors';
+import { AmplifyErrorMap, AssertionFunction } from '../../types';
+
+export enum CacheErrorCode {
+	NoCacheItem = 'NoCacheItem',
+	NullNextNode = 'NullNextNode',
+	NullPreviousNode = 'NullPreviousNode',
+}
+
+const cacheErrorMap: AmplifyErrorMap<CacheErrorCode> = {
+	[CacheErrorCode.NoCacheItem]: {
+		message: 'Item not found in the cache storage.',
+	},
+	[CacheErrorCode.NullNextNode]: {
+		message: 'Next node is null.',
+	},
+	[CacheErrorCode.NullPreviousNode]: {
+		message: 'Previous node is null.',
+	},
+};
+
+export const assert: AssertionFunction<CacheErrorCode> =
+	createAssertionFunction(cacheErrorMap);

package/src/Cache/{Utils → utils}/index.ts

@@ -2,10 +2,9 @@
 // SPDX-License-Identifier: Apache-2.0
 
 export {
-	CacheObject,
-	defaultConfig,
 	getByteLength,
-	getCurrTime,
+	getCurrentSizeKey,
+	getCurrentTime,
 	isInteger,
-} from './CacheUtils';
-export { default as CacheList } from './CacheList';
+} from './cacheHelpers';
+export { CacheList } from './CacheList';

package/src/Hub/index.ts

@@ -2,8 +2,8 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { ConsoleLogger as Logger } from '../Logger';
-import { NO_HUBCALLBACK_PROVIDED_EXCEPTION } from '../Util/Constants';
-import { AmplifyError } from '../Util/Errors';
+import { NO_HUBCALLBACK_PROVIDED_EXCEPTION } from '../constants';
+import { AmplifyError } from '../errors';
 import {
 	AmplifyChannel,
 	AmplifyEventData,
@@ -72,6 +72,7 @@ export class HubClass {
 	 * @param ampSymbol - Symbol used to determine if the event is dispatched internally on a protected channel
 	 *
 	 */
+
 	dispatch<Channel extends AmplifyChannel>(
 		channel: Channel,
 		payload: HubPayload<AmplifyEventData[Channel]>,
@@ -202,3 +203,11 @@ export class HubClass {
 pseudo Singleton for the main messaging bus, however you can still create
 your own instance of HubClass() for a separate "private bus" of events.*/
 export const Hub = new HubClass('__default__');
+
+/**
+ * @internal
+ *
+ * Internal hub used for core Amplify functionality. Not intended for use outside of Amplify.
+ *
+ */
+export const HubInternal = new HubClass('internal-hub');

package/src/Hub/types/AuthTypes.ts

@@ -1,6 +1,11 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+type AuthUser = {
+	username: string;
+	userId: string;
+};
+
 export type AuthHubEventData =
 	/** Dispatched when a user signs in with an oauth provider such as Google.*/
 	| { event: 'signInWithRedirect' }
@@ -9,4 +14,10 @@ export type AuthHubEventData =
 	/** Dispatched when auth tokens are successfully refreshed.*/
 	| { event: 'tokenRefresh' }
 	/** Dispatched when there is an error in the refresh of tokens.*/
-	| { event: 'tokenRefresh_failure' };
+	| { event: 'tokenRefresh_failure' }
+	/** 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.*/
+	| { event: 'signedIn'; data: AuthUser }
+	/** Dispatched after the user calls the `signOut` API successfully.*/
+	| { event: 'signedOut' };

package/src/I18n/I18n.ts

@@ -3,20 +3,18 @@
 
 import { ConsoleLogger as Logger } from '../Logger';
 import { Amplify } from '../singleton';
-import { I18nOptions } from './types';
+import { I18nConfig } from './types';
 
 const logger = new Logger('I18n');
 
 /**
  * Language translation utility.
- * 
- * @deprecated The I18n utility is on a deprecation path and will be removed in a future version of Amplify.
  */
 export class I18n {
 	/**
 	 * @private
 	 */
-	_options: I18nOptions | null = null;
+	_options: I18nConfig | null = null;
 
 	/**
 	 * @private
@@ -32,23 +30,14 @@ export class I18n {
 	 * @constructor
 	 * Initialize with configurations
 	 * @param {Object} options
-	 * 
-	 * @deprecated The I18n utility is on a deprecation path and will be removed in a future version of Amplify.
 	 */
 	constructor() {}
 
 	/**
 	 * Sets the default language from the configuration when required.
-	 * 
-	 * @deprecated The I18n utility is on a deprecation path and will be removed in a future version of Amplify.
 	 */
 	setDefaultLanguage() {
-		/*if (!this._lang) {
-			const i18nConfig = Amplify.getConfig().I18n;
-			this._lang = i18nConfig?.language;
-		}*/
-
-		// Default to window language if not set in config
+		// Default to window language if not set in instance
 		if (
 			!this._lang &&
 			typeof window !== 'undefined' &&
@@ -65,8 +54,6 @@ export class I18n {
 	 * @method
 	 * Explicitly setting language
 	 * @param {String} lang
-	 * 
-	 * @deprecated The I18n utility is on a deprecation path and will be removed in a future version of Amplify.
 	 */
 	setLanguage(lang: string) {
 		this._lang = lang;
@@ -77,8 +64,6 @@ export class I18n {
 	 * Get value
 	 * @param {String} key
 	 * @param {String} defVal - Default value
-	 * 
-	 * @deprecated The I18n utility is on a deprecation path and will be removed in a future version of Amplify.
 	 */
 	get(key: string, defVal: string | undefined = undefined) {
 		if (!this._lang) {
@@ -107,8 +92,6 @@ export class I18n {
 	 * @param {String} key
 	 * @param {String} language - Specified langurage to be used
 	 * @param {String} defVal - Default value
-	 * 
-	 * @deprecated The I18n utility is on a deprecation path and will be removed in a future version of Amplify.
 	 */
 	getByLanguage(key: string, language: string, defVal: string | null = null) {
 		if (!language) {
@@ -128,8 +111,6 @@ export class I18n {
 	 * Add vocabularies for one language
 	 * @param {String} language - Language of the dictionary
 	 * @param {Object} vocabularies - Object that has key-value as dictionary entry
-	 * 
-	 * @deprecated The I18n utility is on a deprecation path and will be removed in a future version of Amplify.
 	 */
 	putVocabulariesForLanguage(
 		language: string,
@@ -147,10 +128,8 @@ export class I18n {
 	 * Add vocabularies for one language
 	 * @param {Object} vocabularies - Object that has language as key,
 	 *                                vocabularies of each language as value
-	 * 
-	 * @deprecated The I18n utility is on a deprecation path and will be removed in a future version of Amplify.
 	 */
-	putVocabularies(vocabularies: Record<string, any>) {
+	putVocabularies(vocabularies: Record<string, Record<string, string>>) {
 		Object.keys(vocabularies).map(key => {
 			this.putVocabulariesForLanguage(key, vocabularies[key]);
 		});

package/src/I18n/errorHelpers.ts

@@ -0,0 +1,18 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { createAssertionFunction } from '../errors';
+import { AmplifyErrorMap, AssertionFunction } from '../types';
+
+export enum I18nErrorCode {
+	NotConfigured = 'NotConfigured',
+}
+
+const i18nErrorMap: AmplifyErrorMap<I18nErrorCode> = {
+	[I18nErrorCode.NotConfigured]: {
+		message: 'i18n is not configured.',
+	},
+};
+
+export const assert: AssertionFunction<I18nErrorCode> =
+	createAssertionFunction(i18nErrorMap);