@aws-amplify/core 5.8.2 → 6.0.1-console-preview.7919075.0

package/src/Cache/Utils/CacheUtils.ts

@@ -0,0 +1,92 @@
+// 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/Utils/index.ts

@@ -0,0 +1,11 @@
+// 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';

package/src/Cache/reactnative.ts

@@ -0,0 +1,9 @@
+// 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

@@ -0,0 +1,75 @@
+// 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/Cache/types/index.ts

@@ -0,0 +1,4 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export * from './Cache';

package/src/ClientDevice/android.ts

@@ -1,6 +1,6 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-
+// @ts-ignore: missing type definition
 import { Platform, Dimensions } from 'react-native';
 import { ConsoleLogger as Logger } from '../Logger';
 

package/src/ClientDevice/ios.ts

@@ -1,6 +1,6 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-
+// @ts-ignore: missing type definition
 import { Platform, Dimensions } from 'react-native';
 import { ConsoleLogger as Logger } from '../Logger';
 
@@ -21,7 +21,7 @@ export const clientInfo = () => {
 	};
 };
 
-function dimToMake(dim) {
+function dimToMake(dim:{height:number, width:number;}) {
 	let { height, width } = dim;
 	if (height < width) {
 		const tmp = height;

package/src/ClientDevice/reactnative.ts

@@ -1,6 +1,6 @@
 // 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';

package/src/Credentials.ts

@@ -1,3 +1,4 @@
+// @ts-nocheck
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import { ConsoleLogger as Logger } from './Logger';
@@ -35,11 +36,12 @@ export class CredentialsClass {
 	private _config;
 	private _credentials;
 	private _credentials_source;
-	private _gettingCredPromise = null;
+	private _gettingCredPromise: any = null;
 	private _refreshHandlers = {};
 	private _storage;
 	private _storageSync;
 	private _identityId;
+	// @ts-ignore
 	private _nextCredentialsRefresh: number;
 
 	// Allow `Auth` to be injected for SSR, but Auth isn't a required dependency for Credentials
@@ -126,7 +128,7 @@ export class CredentialsClass {
 
 		// Some use-cases don't require Auth for signing in, but use Credentials for guest users (e.g. Analytics)
 		// Prefer locally scoped `Auth`, but fallback to registered `Amplify.Auth` global otherwise.
-		const { Auth = Amplify.Auth } = this;
+		const { Auth = Amplify.Auth } = this as any;
 
 		if (!Auth || typeof Auth.currentUserCredentials !== 'function') {
 			// If Auth module is not imported, do a best effort to get guest credentials
@@ -296,10 +298,10 @@ export class CredentialsClass {
 			});
 			return {
 				identityId: this._identityId,
-				accessKeyId: Credentials.AccessKeyId,
-				secretAccessKey: Credentials.SecretKey,
-				sessionToken: Credentials.SessionToken,
-				expiration: Credentials.Expiration,
+				accessKeyId: Credentials!.AccessKeyId,
+				secretAccessKey: Credentials!.SecretKey,
+				sessionToken: Credentials!.SessionToken,
+				expiration: Credentials!.Expiration,
 			};
 		};
 		let credentials = guestCredentialsProvider().catch(async err => {
@@ -334,10 +336,10 @@ export class CredentialsClass {
 
 						return {
 							identityId: IdentityId,
-							accessKeyId: Credentials.AccessKeyId,
-							secretAccessKey: Credentials.SecretKey,
-							sessionToken: Credentials.SessionToken,
-							expiration: Credentials.Expiration,
+							accessKeyId: Credentials!.AccessKeyId,
+							secretAccessKey: Credentials!.SecretKey,
+							sessionToken: Credentials!.SessionToken,
+							expiration: Credentials!.Expiration,
 						};
 					};
 
@@ -399,10 +401,10 @@ export class CredentialsClass {
 			});
 			return {
 				identityId: identity_id,
-				accessKeyId: Credentials.AccessKeyId,
-				secretAccessKey: Credentials.SecretKey,
-				sessionToken: Credentials.SessionToken,
-				expiration: Credentials.Expiration,
+				accessKeyId: Credentials!.AccessKeyId,
+				secretAccessKey: Credentials!.SecretKey,
+				sessionToken: Credentials!.SessionToken,
+				expiration: Credentials!.Expiration,
 			};
 		};
 
@@ -460,10 +462,10 @@ export class CredentialsClass {
 				// single source of truth for the primary identity associated with the logins
 				// only if a guest identity is used for a first-time user, that guest identity will become its primary identity
 				IdentityId: primaryIdentityId,
-			} = await getCredentialsForIdentity(cognitoConfig, {
+			} = (await getCredentialsForIdentity(cognitoConfig, {
 				IdentityId: guestIdentityId || generatedOrRetrievedIdentityId,
 				Logins: logins,
-			});
+			})) as { Credentials: any; IdentityId: string };
 
 			this._identityId = primaryIdentityId;
 			if (guestIdentityId) {
@@ -576,7 +578,7 @@ export class CredentialsClass {
 	}
 
 	/* operations on local stored guest identity */
-	private async _getGuestIdentityId(): Promise<string> {
+	private async _getGuestIdentityId(): Promise<string | undefined> {
 		const { identityPoolId } = this._config;
 		try {
 			await this._storageSync;

package/src/Errors.ts

@@ -1,9 +1,50 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+import { ErrorParams } from './types/types';
+
 export function missingConfig(name: string) {
 	return new Error('Missing config value of ' + name);
 }
 export function invalidParameter(name: string) {
 	return new Error('Invalid parameter value of ' + name);
 }
+
+export enum AmplifyErrorString {
+	UNKNOWN = 'UnknownError',
+	PLATFORM_NOT_SUPPORTED_ERROR = 'PlatformNotSupportedError',
+}
+export class AmplifyError extends Error {
+	underlyingError?: Error | unknown;
+	recoverySuggestion?: string;
+	/**
+	 *  Constructs an AmplifyError.
+	 *
+	 * @param message text that describes the main problem.
+	 * @param underlyingError the underlying cause of the error.
+	 * @param recoverySuggestion suggestion to recover from the error.
+	 *
+	 */
+	constructor({
+		message,
+		name,
+		recoverySuggestion,
+		underlyingError,
+	}: ErrorParams) {
+		super(message);
+
+		this.name = name;
+		this.underlyingError = underlyingError;
+		this.recoverySuggestion = recoverySuggestion;
+
+		// Hack for making the custom error class work when transpiled to es5
+		// TODO: Delete the following 2 lines after we change the build target to >= es2015
+		this.constructor = AmplifyError;
+		Object.setPrototypeOf(this, AmplifyError.prototype);
+	}
+}
+
+export const PlatformNotSupportedError = new AmplifyError({
+	name: AmplifyErrorString.PLATFORM_NOT_SUPPORTED_ERROR,
+	message: 'Function not supported on current platform',
+});

package/src/Hub.ts

@@ -1,3 +1,4 @@
+// @ts-nocheck
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 

package/src/I18n/I18n.ts

@@ -1,39 +1,54 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { I18nOptions } from './types';
 import { ConsoleLogger as Logger } from '../Logger';
+import { AmplifyV6 } from '../singleton';
+import { I18nOptions } from './types';
 
 const logger = new Logger('I18n');
 
 /**
- * Language transition class
+ * 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;
+	_options: I18nOptions | null = null;
 
 	/**
 	 * @private
 	 */
-	_lang = null;
+	_lang?: string | null = null;
 
 	/**
 	 * @private
 	 */
-	_dict = {};
+	_dict: Record<string, any> = {};
 
 	/**
 	 * @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(options: I18nOptions) {
-		this._options = Object.assign({}, options);
-		this._lang = this._options.language;
+	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 = AmplifyV6.getConfig().I18n;
+			this._lang = i18nConfig?.language;
+		}
 
+		// Default to window language if not set in config
 		if (
 			!this._lang &&
 			typeof window !== 'undefined' &&
@@ -50,6 +65,8 @@ 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;
@@ -60,8 +77,10 @@ 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, defVal = undefined) {
+	get(key: string, defVal: string | undefined = undefined) {
 		if (!this._lang) {
 			return typeof defVal !== 'undefined' ? defVal : key;
 		}
@@ -88,8 +107,10 @@ 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, language, defVal = null) {
+	getByLanguage(key: string, language: string, defVal: string | null = null) {
 		if (!language) {
 			return defVal;
 		}
@@ -107,8 +128,13 @@ 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, vocabularies) {
+	putVocabulariesForLanguage(
+		language: string,
+		vocabularies: Record<string, any>
+	) {
 		let lang_dict = this._dict[language];
 		if (!lang_dict) {
 			lang_dict = this._dict[language] = {};
@@ -121,8 +147,10 @@ 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) {
+	putVocabularies(vocabularies: Record<string, any>) {
 		Object.keys(vocabularies).map(key => {
 			this.putVocabulariesForLanguage(key, vocabularies[key]);
 		});

package/src/I18n/index.ts

@@ -4,15 +4,19 @@
 import { I18n as I18nClass } from './I18n';
 
 import { ConsoleLogger as Logger } from '../Logger';
-import { Amplify } from '../Amplify';
+import { I18nOptions } from './types';
+import { asserts } from '../Util/errors/AssertError';
+import { I18N_EXCEPTION } from '../constants';
 
 const logger = new Logger('I18n');
 
-let _config = null;
-let _i18n = null;
+let _config: I18nOptions = { language: null };
+let _i18n: I18nClass | null = null;
 
 /**
  * Export I18n APIs
+ * 
+ * @deprecated The I18n utility is on a deprecation path and will be removed in a future version of Amplify.
  */
 export class I18n {
 	/**
@@ -21,7 +25,7 @@ export class I18n {
 	 * Configure I18n part
 	 * @param {Object} config - Configuration of the I18n
 	 */
-	static configure(config) {
+	static configure(config: Record<string, any>) {
 		logger.debug('configure I18n');
 		if (!config) {
 			return _config;
@@ -42,23 +46,30 @@ export class I18n {
 	 * @static
 	 * @method
 	 * Create an instance of I18n for the library
+	 * 
+	 * @deprecated The I18n utility is on a deprecation path and will be removed in a future version of Amplify.
 	 */
 	static createInstance() {
 		logger.debug('create I18n instance');
 		if (_i18n) {
 			return;
 		}
-		_i18n = new I18nClass(_config);
+		_i18n = new I18nClass();
 	}
 
 	/**
 	 * @static @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.
 	 */
-	static setLanguage(lang) {
+	static setLanguage(lang: string) {
 		I18n.checkConfig();
-
+		asserts(!!_i18n, {
+			name: I18N_EXCEPTION,
+			message: 'I18N is not configured',
+		});
 		return _i18n.setLanguage(lang);
 	}
 
@@ -67,11 +78,17 @@ 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.
 	 */
-	static get(key, defVal?) {
+	static get(key: string, defVal?: string) {
 		if (!I18n.checkConfig()) {
 			return typeof defVal === 'undefined' ? key : defVal;
 		}
+		asserts(!!_i18n, {
+			name: I18N_EXCEPTION,
+			message: 'I18N is not configured',
+		});
 
 		return _i18n.get(key, defVal);
 	}
@@ -82,9 +99,18 @@ export class I18n {
 	 * Add vocabularies for one language
 	 * @param {String} langurage - 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.
 	 */
-	static putVocabulariesForLanguage(language, vocabularies) {
+	static putVocabulariesForLanguage(
+		language: string,
+		vocabularies: Record<string, string>
+	) {
 		I18n.checkConfig();
+		asserts(!!_i18n, {
+			name: I18N_EXCEPTION,
+			message: 'I18N is not configured',
+		});
 
 		return _i18n.putVocabulariesForLanguage(language, vocabularies);
 	}
@@ -95,20 +121,27 @@ 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.
 	 */
-	static putVocabularies(vocabularies) {
+	static putVocabularies(vocabularies: Record<string, string>) {
 		I18n.checkConfig();
+		asserts(!!_i18n, {
+			name: I18N_EXCEPTION,
+			message: 'I18N is not configured',
+		});
 
 		return _i18n.putVocabularies(vocabularies);
 	}
 
 	public static checkConfig() {
 		if (!_i18n) {
-			_i18n = new I18nClass(_config);
+			I18n.createInstance();
 		}
 
 		return true;
 	}
 }
 
-Amplify.register(I18n);
+// Create an instance of I18n in the static class
+I18n.createInstance();

package/src/I18n/types.ts

@@ -1,6 +1,9 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+/**
+ * @deprecated The I18n utility is on a deprecation path and will be removed in a future version of Amplify.
+ */
 export class I18nOptions {
 	language = null;
 }