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

package/src/singleton/Auth/utils/index.ts

@@ -1,6 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { asserts } from '../../../Util/errors/AssertError';
+import { AuthConfigurationErrorCode, assert } from './errorHelpers';
+import { base64Decoder } from '../../../utils/convert';
 
 import {
 	AuthConfig,
@@ -27,14 +28,13 @@ export function assertTokenProviderConfig(
 		assertionValid = false;
 	} else {
 		assertionValid =
-			!!cognitoConfig.userPoolClientId && !!cognitoConfig.userPoolClientId;
+			!!cognitoConfig.userPoolId && !!cognitoConfig.userPoolClientId;
 	}
 
-	return asserts(assertionValid, {
-		name: 'AuthTokenConfigException',
-		message: 'Auth Token Provider not configured',
-		recoverySuggestion: 'Make sure to call Amplify.configure in your app',
-	});
+	return assert(
+		assertionValid,
+		AuthConfigurationErrorCode.AuthTokenConfigException
+	);
 }
 
 export function assertOAuthConfig(
@@ -46,15 +46,13 @@ export function assertOAuthConfig(
 		!!cognitoConfig?.loginWith?.oauth?.redirectSignIn &&
 		!!cognitoConfig?.loginWith?.oauth?.responseType;
 
-	return asserts(validOAuthConfig, {
-		name: 'OAuthNotConfigureException',
-		message: 'oauth param not configured',
-		recoverySuggestion:
-			'Make sure to call Amplify.configure with oauth parameter in your app',
-	});
+	return assert(
+		validOAuthConfig,
+		AuthConfigurationErrorCode.OAuthNotConfigureException
+	);
 }
 
-export function assertIdentityPooIdConfig(
+export function assertIdentityPoolIdConfig(
 	cognitoConfig?: StrictUnion<
 		| CognitoUserPoolConfig
 		| CognitoUserPoolAndIdentityPoolConfig
@@ -62,37 +60,41 @@ export function assertIdentityPooIdConfig(
 	>
 ): asserts cognitoConfig is CognitoIdentityPoolConfig {
 	const validConfig = !!cognitoConfig?.identityPoolId;
-	return asserts(validConfig, {
-		name: 'InvalidIdentityPoolIdException',
-		message: 'Invalid identity pool id provided.',
-		recoverySuggestion:
-			'Make sure a valid identityPoolId is given in the config.',
-	});
+	return assert(
+		validConfig,
+		AuthConfigurationErrorCode.InvalidIdentityPoolIdException
+	);
 }
 
-function assertUserPoolAndIdentityPooConfig(
+function assertUserPoolAndIdentityPoolConfig(
 	authConfig: AuthConfig
 ): asserts authConfig is AuthUserPoolAndIdentityPoolConfig {
 	const validConfig =
 		!!authConfig?.Cognito.identityPoolId && !!authConfig?.Cognito.userPoolId;
-	return asserts(validConfig, {
-		name: 'AuthUserPoolAndIdentityPoolException',
-		message: 'Auth UserPool and IdentityPool not configured',
-		recoverySuggestion:
-			'Make sure to call Amplify.configure in your app with UserPoolId and IdentityPoolId',
-	});
+	return assert(
+		validConfig,
+		AuthConfigurationErrorCode.AuthUserPoolAndIdentityPoolException
+	);
 }
 
 export function decodeJWT(token: string): JWT {
-	const tokenSplitted = token.split('.');
-	if (tokenSplitted.length !== 3) {
+	const tokenParts = token.split('.');
+
+	if (tokenParts.length !== 3) {
 		throw new Error('Invalid token');
 	}
+
 	try {
-		const payloadStringb64 = tokenSplitted[1];
-		const payloadArrayBuffer = base64ToBytes(payloadStringb64);
-		const decodeString = new TextDecoder().decode(payloadArrayBuffer);
-		const payload = JSON.parse(decodeString);
+		const base64WithUrlSafe = tokenParts[1];
+		const base64 = base64WithUrlSafe.replace(/-/g, '+').replace(/_/g, '/');
+		const jsonStr = decodeURIComponent(
+			base64Decoder
+				.convert(base64)
+				.split('')
+				.map(char => `%${`00${char.charCodeAt(0).toString(16)}`.slice(-2)}`)
+				.join('')
+		);
+		const payload = JSON.parse(jsonStr);
 
 		return {
 			toString: () => token,
@@ -102,8 +104,3 @@ export function decodeJWT(token: string): JWT {
 		throw new Error('Invalid token payload');
 	}
 }
-
-function base64ToBytes(base64: string): Uint8Array {
-	const binString = atob(base64);
-	return Uint8Array.from(binString, m => m.codePointAt(0) || 0);
-}

package/src/singleton/Cache/types.ts

@@ -0,0 +1,27 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * 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;
+}

package/src/singleton/Geo/types.ts

@@ -0,0 +1,20 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export interface GeoConfig {
+	LocationService?: {
+		region: string;
+		maps?: {
+			items: {};
+			default: string;
+		};
+		searchIndices?: {
+			items: string[];
+			default: string;
+		};
+		geofenceCollections?: {
+			items: string[];
+			default: string;
+		};
+	};
+}

package/src/singleton/Interactions/types.ts

@@ -0,0 +1,29 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+interface LexV1BotConfig {
+	alias: string;
+	region: string;
+}
+
+interface LexV2BotConfig {
+	botId: string;
+	aliasId: string;
+	localeId: string;
+	region: string;
+}
+
+type InteractionsLexV1Config = {
+	LexV1: Record<string, LexV1BotConfig>;
+};
+
+type InteractionsLexV2Config = {
+	LexV2: Record<string, LexV2BotConfig>;
+};
+
+type AtLeastOne<T, U = { [K in keyof T]: Pick<T, K> }> = Partial<T> &
+	U[keyof U];
+
+export type InteractionsConfig = AtLeastOne<
+	InteractionsLexV1Config & InteractionsLexV2Config
+>;

package/src/singleton/Notifications/InAppMessaging/types.ts

@@ -0,0 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { PinpointProviderConfig } from '../../../providers/pinpoint/types';
+
+export type InAppMessagingConfig = PinpointProviderConfig;

package/src/singleton/Notifications/PushNotification/types.ts

@@ -0,0 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { PinpointProviderConfig } from '../../../providers/pinpoint/types';
+
+export type PushNotificationConfig = PinpointProviderConfig;

package/src/singleton/Notifications/types.ts

@@ -0,0 +1,10 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { InAppMessagingConfig } from './InAppMessaging/types';
+import { PushNotificationConfig } from './PushNotification/types';
+
+export type NotificationsConfig = {
+	InAppMessaging?: InAppMessagingConfig;
+	PushNotification?: PushNotificationConfig;
+};

package/src/singleton/Predictions/types.ts

@@ -0,0 +1,61 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+// Defaults for ConvertConfig
+type SpeechGeneratorDefaults = {
+	voiceId?: string;
+};
+type TranscriptionDefaults = {
+	language?: string;
+};
+type TranslateTextDefaults = {
+	sourceLanguage?: string;
+	targetLanguage?: string;
+};
+
+// Defaults for IdentifyConfig
+type IdentifyEntitiesDefaults = {
+	collectionId?: string;
+	maxEntities?: number;
+};
+type IdentityLabelsDefaults = {
+	type?: string;
+};
+type IdentifyTextDefaults = {
+	format?: string;
+};
+
+// Defaults for InterpretConfig
+type InterpretTextDefaults = {
+	type?: string;
+};
+
+type ConvertConfig = {
+	speechGenerator?: PredictionsProviderConfig<SpeechGeneratorDefaults>;
+	transcription?: PredictionsProviderConfig<TranscriptionDefaults>;
+	translateText?: PredictionsProviderConfig<TranslateTextDefaults>;
+};
+
+type IdentifyConfig = {
+	identifyEntities?: PredictionsProviderConfig<IdentifyEntitiesDefaults> & {
+		celebrityDetectionEnabled?: boolean;
+	};
+	identifyLabels?: PredictionsProviderConfig<IdentityLabelsDefaults>;
+	identifyText?: PredictionsProviderConfig<IdentifyTextDefaults>;
+};
+
+type InterpretConfig = {
+	interpretText?: PredictionsProviderConfig<InterpretTextDefaults>;
+};
+
+export type PredictionsProviderConfig<T> = {
+	region?: string;
+	proxy?: boolean;
+	defaults?: T;
+};
+
+export type PredictionsConfig = {
+	convert?: ConvertConfig;
+	identify?: IdentifyConfig;
+	interpret?: InterpretConfig;
+};

package/src/singleton/types.ts

@@ -1,6 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+import { APIConfig, LibraryAPIOptions } from './API/types';
 import { AnalyticsConfig } from './Analytics/types';
 import {
 	AuthConfig,
@@ -11,11 +12,15 @@ import {
 	GetCredentialsOptions,
 	CognitoIdentityPoolConfig,
 } from './Auth/types';
+import { GeoConfig } from './Geo/types';
+import { PredictionsConfig } from './Predictions/types';
 import {
 	LibraryStorageOptions,
 	StorageAccessLevel,
 	StorageConfig,
 } from './Storage/types';
+import { NotificationsConfig } from './Notifications/types';
+import { InteractionsConfig } from './Interactions/types';
 
 export type LegacyConfig = {
 	/**
@@ -25,32 +30,35 @@ export type LegacyConfig = {
 };
 
 export type ResourcesConfig = {
-	// API?: {};
+	API?: APIConfig;
 	Analytics?: AnalyticsConfig;
 	Auth?: AuthConfig;
-	// Cache?: CacheConfig;
-	// DataStore?: {};
-	// I18n?: I18nOptions;
-	// Interactions?: {};
-	// Notifications?: {};
-	// Predictions?: {};
+	Interactions?: InteractionsConfig;
+	Notifications?: NotificationsConfig;
+	Predictions?: PredictionsConfig;
 	Storage?: StorageConfig;
+	Geo?: GeoConfig;
 };
 
 export type LibraryOptions = {
+	API?: LibraryAPIOptions;
 	Auth?: LibraryAuthOptions;
 	Storage?: LibraryStorageOptions;
 	ssr?: boolean;
 };
 
 export {
+	APIConfig,
 	AuthConfig,
 	AuthUserPoolConfig,
 	AuthIdentityPoolConfig,
 	AuthUserPoolAndIdentityPoolConfig,
 	GetCredentialsOptions,
+	InteractionsConfig,
+	PredictionsConfig,
 	StorageAccessLevel,
 	StorageConfig,
 	AnalyticsConfig,
 	CognitoIdentityPoolConfig,
+	GeoConfig,
 };

package/src/storage/CookieStorage.native.ts

@@ -0,0 +1,13 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { KeyValueStorage } from './KeyValueStorage';
+
+/**
+ * @internal
+ */
+export class CookieStorage extends KeyValueStorage {
+	constructor() {
+		super();
+	}
+}

package/src/storage/CookieStorage.ts

@@ -0,0 +1,68 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import JsCookie from 'js-cookie';
+import {
+	CookieStorageData,
+	KeyValueStorageInterface,
+	SameSite,
+} from '../types';
+
+export class CookieStorage implements KeyValueStorageInterface {
+	path: string;
+	domain?: string;
+	expires?: number;
+	sameSite?: SameSite;
+	secure?: boolean;
+
+	constructor(data: CookieStorageData = {}) {
+		const { path, domain, expires, sameSite, secure } = data;
+		this.domain = domain;
+		this.path = path ? path : '/';
+		this.expires = data.hasOwnProperty('expires') ? expires : 365;
+		this.secure = data.hasOwnProperty('secure') ? secure : true;
+
+		if (data.hasOwnProperty('sameSite')) {
+			if (!sameSite || !['strict', 'lax', 'none'].includes(sameSite)) {
+				throw new Error(
+					'The sameSite value of cookieStorage must be "lax", "strict" or "none".'
+				);
+			}
+			if (sameSite === 'none' && !this.secure) {
+				throw new Error(
+					'sameSite = None requires the Secure attribute in latest browser versions.'
+				);
+			}
+			this.sameSite = sameSite;
+		}
+	}
+
+	async setItem(key: string, value: string) {
+		JsCookie.set(key, value, this.getData());
+	}
+
+	async getItem(key: string) {
+		const item = JsCookie.get(key);
+		return item ?? null;
+	}
+
+	async removeItem(key: string) {
+		JsCookie.remove(key, this.getData());
+	}
+
+	async clear() {
+		const cookie = JsCookie.get();
+		const promises = Object.keys(cookie).map(key => this.removeItem(key));
+		await Promise.all(promises);
+	}
+
+	private getData(): CookieStorageData {
+		return {
+			path: this.path,
+			expires: this.expires,
+			domain: this.domain,
+			secure: this.secure,
+			...(this.sameSite && { sameSite: this.sameSite }),
+		};
+	}
+}

package/src/storage/DefaultStorage.native.ts

@@ -0,0 +1,58 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { loadAsyncStorage } from '@aws-amplify/react-native';
+import { KeyValueStorageInterface } from '../types';
+
+const MEMORY_KEY_PREFIX = '@MemoryStorage:';
+
+/**
+ * @internal
+ */
+export class DefaultStorage implements KeyValueStorageInterface {
+	private asyncStorage: ReturnType<typeof loadAsyncStorage>;
+
+	constructor() {
+		this.asyncStorage = loadAsyncStorage();
+	}
+
+	/**
+	 * This is used to set a specific item in storage
+	 * @param {string} key - the key for the item
+	 * @param {object} value - the value
+	 * @returns {string} value that was set
+	 */
+	setItem(key: string, value: string) {
+		return this.asyncStorage.setItem(`${MEMORY_KEY_PREFIX}${key}`, value);
+	}
+
+	/**
+	 * This is used to get a specific key from storage
+	 * @param {string} key - the key for the item
+	 * This is used to clear the storage
+	 * @returns {string} the data item
+	 */
+	getItem(key: string) {
+		return this.asyncStorage.getItem(`${MEMORY_KEY_PREFIX}${key}`);
+	}
+
+	/**
+	 * This is used to remove an item from storage
+	 * @param {string} key - the key being set
+	 * @returns {string} value - value that was deleted
+	 */
+	removeItem(key: string): Promise<void> {
+		return this.asyncStorage.removeItem(`${MEMORY_KEY_PREFIX}${key}`);
+	}
+
+	/**
+	 * This is used to clear the storage
+	 * @returns {string} nothing
+	 */
+	async clear(): Promise<void> {
+		const allKeys = await this.asyncStorage.getAllKeys();
+		return this.asyncStorage.multiRemove(
+			allKeys.filter(key => key.startsWith(MEMORY_KEY_PREFIX))
+		);
+	}
+}

package/src/storage/DefaultStorage.ts

@@ -0,0 +1,14 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { KeyValueStorage } from './KeyValueStorage';
+import { getLocalStorageWithFallback } from './utils';
+
+/**
+ * @internal
+ */
+export class DefaultStorage extends KeyValueStorage {
+	constructor() {
+		super(getLocalStorageWithFallback());
+	}
+}

package/src/storage/InMemoryStorage.ts

@@ -0,0 +1,36 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * @internal
+ */
+export class InMemoryStorage implements Storage {
+	storage = new Map<string, string>();
+
+	get length() {
+		return this.storage.size;
+	}
+
+	key(index: number) {
+		if (index > this.length - 1) {
+			return null;
+		}
+		return Array.from(this.storage.keys())[index];
+	}
+
+	setItem(key: string, value: string) {
+		this.storage.set(key, value);
+	}
+
+	getItem(key: string) {
+		return this.storage.get(key) ?? null;
+	}
+
+	removeItem(key: string) {
+		this.storage.delete(key);
+	}
+
+	clear() {
+		this.storage.clear();
+	}
+}

package/src/{StorageHelper/sessionStorage.ts → storage/KeyValueStorage.ts}

@@ -1,18 +1,17 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { PlatformNotSupportedError } from '../Util/Errors';
+import { PlatformNotSupportedError } from '../errors';
 import { KeyValueStorageInterface } from '../types';
 
-class SessionStorageClass implements KeyValueStorageInterface {
+/**
+ * @internal
+ */
+export class KeyValueStorage implements KeyValueStorageInterface {
 	storage?: Storage;
 
-	constructor() {
-		if (typeof window !== undefined) {
-			try {
-				this.storage = window?.sessionStorage;
-			} catch (error) {}
-		}
+	constructor(storage?: Storage) {
+		this.storage = storage;
 	}
 
 	/**
@@ -21,8 +20,8 @@ class SessionStorageClass implements KeyValueStorageInterface {
 	 * @param {object} value - the value
 	 * @returns {string} value that was set
 	 */
-	async setItem(key: string, value: string): Promise<void> {
-		if (!this.storage) throw PlatformNotSupportedError;
+	async setItem(key: string, value: string) {
+		if (!this.storage) throw new PlatformNotSupportedError();
 		this.storage.setItem(key, value);
 	}
 
@@ -32,8 +31,8 @@ class SessionStorageClass implements KeyValueStorageInterface {
 	 * This is used to clear the storage
 	 * @returns {string} the data item
 	 */
-	async getItem(key: string): Promise<string | null> {
-		if (!this.storage) throw PlatformNotSupportedError;
+	async getItem(key: string) {
+		if (!this.storage) throw new PlatformNotSupportedError();
 		return this.storage.getItem(key);
 	}
 
@@ -42,8 +41,8 @@ class SessionStorageClass implements KeyValueStorageInterface {
 	 * @param {string} key - the key being set
 	 * @returns {string} value - value that was deleted
 	 */
-	async removeItem(key: string): Promise<void> {
-		if (!this.storage) throw PlatformNotSupportedError;
+	async removeItem(key: string) {
+		if (!this.storage) throw new PlatformNotSupportedError();
 		this.storage.removeItem(key);
 	}
 
@@ -51,10 +50,8 @@ class SessionStorageClass implements KeyValueStorageInterface {
 	 * This is used to clear the storage
 	 * @returns {string} nothing
 	 */
-	async clear(): Promise<void> {
-		if (!this.storage) throw PlatformNotSupportedError;
+	async clear() {
+		if (!this.storage) throw new PlatformNotSupportedError();
 		this.storage.clear();
 	}
 }
-
-export const SessionStorage = new SessionStorageClass();

package/src/storage/SessionStorage.ts

@@ -0,0 +1,14 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { KeyValueStorage } from './KeyValueStorage';
+import { getSessionStorageWithFallback } from './utils';
+
+/**
+ * @internal
+ */
+export class SessionStorage extends KeyValueStorage {
+	constructor() {
+		super(getSessionStorageWithFallback());
+	}
+}

package/src/storage/index.ts

@@ -0,0 +1,13 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { DefaultStorage } from './DefaultStorage';
+import { InMemoryStorage } from './InMemoryStorage';
+import { KeyValueStorage } from './KeyValueStorage';
+import { SessionStorage } from './SessionStorage';
+
+export { CookieStorage } from './CookieStorage';
+
+export const defaultStorage = new DefaultStorage();
+export const sessionStorage = new SessionStorage();
+export const sharedInMemoryStorage = new KeyValueStorage(new InMemoryStorage());

package/src/storage/utils.ts

@@ -0,0 +1,22 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { InMemoryStorage } from './InMemoryStorage';
+
+/**
+ * @internal
+ * @returns Either a reference to window.localStorage or an in-memory storage as fallback
+ */
+export const getLocalStorageWithFallback = (): Storage =>
+	typeof window !== 'undefined' && window.localStorage
+		? window.localStorage
+		: new InMemoryStorage();
+
+/**
+ * @internal
+ * @returns Either a reference to window.sessionStorage or an in-memory storage as fallback
+ */
+export const getSessionStorageWithFallback = (): Storage =>
+	typeof window !== 'undefined' && window.sessionStorage
+		? window.sessionStorage
+		: new InMemoryStorage();