@aws-amplify/core 6.0.1-console-preview.d7e0545.0 → 6.0.1-console-preview.7739091.0

package/src/libraryUtils.ts

@@ -7,7 +7,7 @@ utils for use throughout the library.
 */
 // JS utilities
 export {
-	browserOrNode,
+	isBrowser,
 	filenameToContentType,
 	generateRandomString,
 	isEmpty,
@@ -96,7 +96,6 @@ export {
 	AmplifyError,
 	AmplifyErrorString,
 } from './Util/Errors';
-export { FacebookOAuth, GoogleOAuth } from './OAuthHelper';
 export { AppState, AsyncStorage, Linking } from './RNComponents';
 export { ErrorParams, AmplifyErrorMap, ServiceError } from './types';
 export {

package/src/parseAWSExports.ts

@@ -3,6 +3,12 @@
 import { OAuthConfig } from './singleton/Auth/types';
 import { ResourcesConfig } from './singleton/types';
 
+const authTypeMapping: Record<any, any> = {
+	API_KEY: 'apiKey',
+	AWS_IAM: 'iam',
+	AMAZON_COGNITO_USER_POOLS: 'jwt',
+};
+
 /**
  * This utility converts the `aws-exports.js` file generated by the Amplify CLI into a {@link ResourcesConfig} object
  * consumable by Amplify.
@@ -11,10 +17,15 @@ import { ResourcesConfig } from './singleton/types';
  *
  * @returns A {@link ResourcesConfig} object.
  */
+
 export const parseAWSExports = (
 	config: Record<string, any> = {}
 ): ResourcesConfig => {
 	const {
+		aws_appsync_apiKey,
+		aws_appsync_authenticationType,
+		aws_appsync_graphqlEndpoint,
+		aws_appsync_region,
 		aws_cognito_identity_pool_id,
 		aws_cognito_sign_up_verification_method,
 		aws_mandatory_sign_in,
@@ -40,6 +51,21 @@ export const parseAWSExports = (
 		};
 	}
 
+	// TODO: Need to support all API configurations
+	// API
+	if (aws_appsync_graphqlEndpoint) {
+		amplifyConfig.API = {
+			AppSync: {
+				defaultAuthMode: {
+					type: authTypeMapping[aws_appsync_authenticationType],
+					apiKey: aws_appsync_apiKey,
+				},
+				endpoint: aws_appsync_graphqlEndpoint,
+				region: aws_appsync_region,
+			},
+		};
+	}
+
 	// Auth
 	if (aws_cognito_identity_pool_id || aws_user_pools_id) {
 		amplifyConfig.Auth = {

package/src/providers/pinpoint/apis/record.ts

@@ -2,9 +2,9 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { v4 as uuid } from 'uuid';
-import { PinpointRecordParameters, PinpointSession } from '../types';
+import { PinpointRecordInput, PinpointSession } from '../types';
 import { getEndpointId } from '../utils';
-import { 
+import {
 	BUFFER_SIZE,
 	FLUSH_INTERVAL,
 	FLUSH_SIZE,
@@ -28,11 +28,11 @@ export const record = async ({
 	identityId,
 	region,
 	userAgentValue,
-}: PinpointRecordParameters): Promise<void> => {
+}: PinpointRecordInput): Promise<void> => {
 	const timestampISOString = new Date().toISOString();
 	const eventId = uuid();
 	let endpointId = await getEndpointId(appId, category);
-  
+
 	// Prepare event buffer if required
 	const buffer = getEventBuffer({
 		appId,
@@ -43,7 +43,7 @@ export const record = async ({
 		identityId,
 		region,
 		resendLimit: RESEND_LIMIT,
-		userAgentValue
+		userAgentValue,
 	});
 
 	// Prepare a Pinpoint endpoint via updateEndpoint if one does not already exist, which will generate and cache an
@@ -64,7 +64,7 @@ export const record = async ({
 	if (!endpointId) {
 		throw new AmplifyError({
 			name: 'ENDPOINT_NOT_CREATED',
-			message: 'Endpoint was not created.'
+			message: 'Endpoint was not created.',
 		});
 	}
 
@@ -77,7 +77,7 @@ export const record = async ({
 			StartTimestamp: timestampISOString,
 		};
 	}
-  
+
 	// Push event to buffer
 	buffer.push({
 		eventId,
@@ -85,6 +85,6 @@ export const record = async ({
 		event,
 		session,
 		timestamp: timestampISOString,
-		resendLimit: RESEND_LIMIT
+		resendLimit: RESEND_LIMIT,
 	});
 };

package/src/providers/pinpoint/apis/updateEndpoint.ts

@@ -7,7 +7,7 @@ import {
 	updateEndpoint as clientUpdateEndpoint,
 	UpdateEndpointInput,
 } from '../../../AwsClients/Pinpoint';
-import { PinpointUpdateEndpointParameters } from '../types';
+import { PinpointUpdateEndpointInput } from '../types';
 import { cacheEndpointId, getEndpointId } from '../utils';
 
 /**
@@ -25,7 +25,7 @@ export const updateEndpoint = async ({
 	userId,
 	userProfile,
 	userAgentValue,
-}: PinpointUpdateEndpointParameters): Promise<void> => {
+}: PinpointUpdateEndpointInput): Promise<void> => {
 	const endpointId = await getEndpointId(appId, category);
 	// only generate a new endpoint id if one was not found in cache
 	const createdEndpointId = !endpointId ? uuidv4() : undefined;

package/src/providers/pinpoint/types/pinpoint.ts

@@ -44,12 +44,13 @@ type PinpointCommonParameters = {
 	userAgentValue?: string;
 };
 
-export type PinpointUpdateEndpointParameters = PinpointCommonParameters & PinpointServiceOptions & {
-	channelType?: SupportedChannelType;
-	userId?: string;
-	userProfile?: UserProfile;
-};
+export type PinpointUpdateEndpointInput = PinpointCommonParameters &
+	PinpointServiceOptions & {
+		channelType?: SupportedChannelType;
+		userId?: string;
+		userProfile?: UserProfile;
+	};
 
-export type PinpointRecordParameters = PinpointCommonParameters & {
+export type PinpointRecordInput = PinpointCommonParameters & {
 	event: PinpointAnalyticsEvent;
 };

package/src/singleton/API/types.ts

@@ -0,0 +1,31 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export type LibraryAPIOptions = {
+	AppSync: {
+		query: string;
+		variables?: object;
+		authMode?: any;
+		authToken?: string;
+		/**
+		 * @deprecated This property should not be used
+		 */
+		userAgentSuffix?: string;
+	};
+	customHeaders: Function;
+};
+
+export type APIConfig = {
+	AppSync?: {
+		defaultAuthMode?: GraphQLAuthMode;
+		region?: string;
+		endpoint?: string;
+		modelIntrospectionSchema?: any;
+	};
+};
+
+export type GraphQLAuthMode =
+	| { type: 'apiKey'; apiKey: string }
+	| { type: 'jwt'; token: 'id' | 'access' }
+	| { type: 'iam' }
+	| { type: 'lambda' }
+	| { type: 'custom' };

package/src/singleton/Auth/index.ts

@@ -8,8 +8,6 @@ import {
 	FetchAuthSessionOptions,
 	LibraryAuthOptions,
 } from './types';
-import { asserts } from '../../Util/errors/AssertError';
-import { AUTH_CONFING_EXCEPTION } from '../../Util/Constants';
 
 export function isTokenExpired({
 	expiresAt,
@@ -53,13 +51,6 @@ export class AuthClass {
 		let credentialsAndIdentityId: AWSCredentialsAndIdentityId | undefined;
 		let userSub: string | undefined;
 
-		asserts(!!this.authConfig, {
-			name: AUTH_CONFING_EXCEPTION,
-			message: 'AuthConfig is required',
-			recoverySuggestion:
-				'call Amplify.configure in your app with a valid AuthConfig',
-		});
-
 		// Get tokens will throw if session cannot be refreshed (network or service error) or return null if not available
 		tokens =
 			(await this.authOptions?.tokenProvider?.getTokens(options)) ?? undefined;
@@ -77,7 +68,7 @@ export class AuthClass {
 						forceRefresh: options.forceRefresh,
 					}
 				);
-		} else if (this.authConfig.Cognito.allowGuestAccess) {
+		} else {
 			// getCredentialsAndIdentityId will throw if cannot get credentials (network or service error)
 			credentialsAndIdentityId =
 				await this.authOptions?.credentialsProvider?.getCredentialsAndIdentityId(

package/src/singleton/Auth/types.ts

@@ -152,14 +152,14 @@ export type GetCredentialsOptions =
 type GetCredentialsAuthenticatedUser = {
 	authenticated: true;
 	forceRefresh?: boolean;
-	authConfig: AuthConfig;
+	authConfig: AuthConfig | undefined;
 	tokens: AuthTokens;
 };
 
 type GetCredentialsUnauthenticatedUser = {
 	authenticated: false;
 	forceRefresh?: boolean;
-	authConfig: AuthConfig;
+	authConfig: AuthConfig | undefined;
 	tokens?: never;
 };
 

package/src/singleton/Storage/types.ts

@@ -7,8 +7,13 @@ export interface StorageConfig {
 	S3: {
 		bucket?: string;
 		region?: string;
+		/**
+		 * Internal-only configuration for testing purpose. You should not use this.
+		 *
+		 * @internal
+		 */
 		dangerouslyConnectToHttpEndpointForTesting?: string;
-	}
+	};
 }
 
 type StoragePrefixResolver = (params: {
@@ -16,7 +21,6 @@ type StoragePrefixResolver = (params: {
 	targetIdentityId?: string;
 }) => Promise<string>;
 
-// TODO[AllanZhengYP]: need to finalize the decision whether to move defaultAccessLevel to StorageConfig
 export interface LibraryStorageOptions {
 	S3: {
 		prefixResolver?: StoragePrefixResolver;

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,
@@ -18,7 +19,7 @@ import {
 } from './Storage/types';
 
 export type ResourcesConfig = {
-	// API?: {};
+	API?: APIConfig;
 	Analytics?: AnalyticsConfig;
 	Auth?: AuthConfig;
 	// Cache?: CacheConfig;
@@ -31,12 +32,14 @@ export type ResourcesConfig = {
 };
 
 export type LibraryOptions = {
+	API?: LibraryAPIOptions;
 	Auth?: LibraryAuthOptions;
 	Storage?: LibraryStorageOptions;
 	ssr?: boolean;
 };
 
 export {
+	APIConfig,
 	AuthConfig,
 	AuthUserPoolConfig,
 	AuthIdentityPoolConfig,

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,72 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	get as getJsCookie,
+	remove as removeJsCookie,
+	set as setJsCookie,
+} 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) {
+		setJsCookie(key, value, this.getData());
+	}
+
+	async getItem(key: string) {
+		const item = getJsCookie(key);
+		return item ?? null;
+	}
+
+	async removeItem(key: string) {
+		removeJsCookie(key, this.getData());
+	}
+
+	async clear() {
+		const cookie = getJsCookie();
+		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,78 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import type { AsyncStorageStatic } from '@react-native-async-storage/async-storage';
+import { AmplifyError } from '../libraryUtils';
+import { KeyValueStorageInterface } from '../types';
+
+const ASYNC_STORAGE_MODULE = '@react-native-async-storage/async-storage';
+const MEMORY_KEY_PREFIX = '@MemoryStorage:';
+
+/**
+ * @internal
+ */
+export class DefaultStorage implements KeyValueStorageInterface {
+	private asyncStorage?: AsyncStorageStatic;
+
+	/**
+	 * 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) {
+		this.assertModule(this.asyncStorage);
+		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) {
+		this.assertModule(this.asyncStorage);
+		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> {
+		this.assertModule(this.asyncStorage);
+		return this.asyncStorage.removeItem(`${MEMORY_KEY_PREFIX}${key}`);
+	}
+
+	/**
+	 * This is used to clear the storage
+	 * @returns {string} nothing
+	 */
+	async clear(): Promise<void> {
+		this.assertModule(this.asyncStorage);
+		const allKeys = await this.asyncStorage.getAllKeys();
+		return this.asyncStorage.multiRemove(
+			allKeys.filter(key => key.startsWith(MEMORY_KEY_PREFIX))
+		);
+	}
+
+	private assertModule(
+		asyncStorage?: AsyncStorageStatic
+	): asserts asyncStorage {
+		if (!!asyncStorage) {
+			return;
+		}
+		try {
+			this.asyncStorage = require(ASYNC_STORAGE_MODULE)
+				.default as AsyncStorageStatic;
+		} catch (err) {
+			throw new AmplifyError({
+				name: 'NativeModuleException',
+				message: `Unable to find ${ASYNC_STORAGE_MODULE}`,
+				recoverySuggestion: `Make sure to install ${ASYNC_STORAGE_MODULE}`,
+			});
+		}
+	}
+}

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 { getDefaultStorageWithFallback } from './utils';
+
+/**
+ * @internal
+ */
+export class DefaultStorage extends KeyValueStorage {
+	constructor() {
+		super(getDefaultStorageWithFallback());
+	}
+}

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}

@@ -4,15 +4,14 @@
 import { PlatformNotSupportedError } from '../Util/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,7 +20,7 @@ class SessionStorageClass implements KeyValueStorageInterface {
 	 * @param {object} value - the value
 	 * @returns {string} value that was set
 	 */
-	async setItem(key: string, value: string): Promise<void> {
+	async setItem(key: string, value: string) {
 		if (!this.storage) throw PlatformNotSupportedError;
 		this.storage.setItem(key, value);
 	}
@@ -32,7 +31,7 @@ class SessionStorageClass implements KeyValueStorageInterface {
 	 * This is used to clear the storage
 	 * @returns {string} the data item
 	 */
-	async getItem(key: string): Promise<string | null> {
+	async getItem(key: string) {
 		if (!this.storage) throw PlatformNotSupportedError;
 		return this.storage.getItem(key);
 	}
@@ -42,7 +41,7 @@ class SessionStorageClass implements KeyValueStorageInterface {
 	 * @param {string} key - the key being set
 	 * @returns {string} value - value that was deleted
 	 */
-	async removeItem(key: string): Promise<void> {
+	async removeItem(key: string) {
 		if (!this.storage) throw 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> {
+	async clear() {
 		if (!this.storage) throw 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 getDefaultStorageWithFallback = (): 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();

package/src/types/storage.ts

@@ -13,6 +13,10 @@ export type SameSite = 'strict' | 'lax' | 'none';
 export type CookieStorageData = {
 	domain?: string;
 	path?: string;
+
+	/**
+	 * Expiration in days
+	 */
 	expires?: number;
 	secure?: boolean;
 	sameSite?: SameSite;

package/lib/OAuthHelper/FacebookOAuth.d.ts

@@ -1,6 +0,0 @@
-export declare class FacebookOAuth {
-    initialized: boolean;
-    constructor();
-    refreshFacebookToken(): Promise<unknown>;
-    private _refreshFacebookTokenImpl;
-}