@aws-amplify/core 5.8.6-unstable.7762f1a.0 → 6.0.0

package/src/libraryUtils.ts

@@ -0,0 +1,113 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import WordArray from './utils/WordArray';
+/*
+This file maps top-level exports from `@aws-amplify/core/internals/utils`. These are intended to be internal
+utils for use throughout the library.
+*/
+// Core utilities
+export {
+	generateRandomString,
+	isBrowser,
+	isNonRetryableError,
+	isWebWorker,
+	jitteredBackoff,
+	jitteredExponentialRetry,
+	NonRetryableError,
+	retry,
+	urlSafeDecode,
+	urlSafeEncode,
+} from './utils';
+export { parseAWSExports } from './parseAWSExports';
+export { LegacyConfig } from './singleton/types';
+export { amplifyUuid } from './utils/amplifyUuid';
+export { AmplifyUrl, AmplifyUrlSearchParams } from './utils/amplifyUrl';
+
+// Auth utilities
+export {
+	decodeJWT,
+	assertTokenProviderConfig,
+	assertIdentityPoolIdConfig,
+	assertOAuthConfig,
+} from './singleton/Auth/utils';
+export { isTokenExpired } from './singleton/Auth';
+export { GraphQLAuthMode, DocumentType } from './singleton/API/types';
+export { Signer } from './Signer';
+export {
+	JWT,
+	StrictUnion,
+	CognitoIdentityPoolConfig,
+	JwtPayload,
+	AuthStandardAttributeKey,
+	AuthVerifiableAttributeKey,
+	AWSCredentials,
+} from './singleton/Auth/types';
+
+// Platform & user-agent utilities
+export {
+	Platform,
+	getAmplifyUserAgentObject,
+	getAmplifyUserAgent,
+} from './Platform';
+export {
+	ApiAction,
+	AuthAction,
+	AnalyticsAction,
+	Category,
+	CustomUserAgentDetails,
+	DataStoreAction,
+	Framework,
+	GeoAction,
+	InteractionsAction,
+	InAppMessagingAction,
+	PredictionsAction,
+	PubSubAction,
+	PushNotificationAction,
+	StorageAction,
+	SetCustomUserAgentInput,
+	StorageUserAgentInput,
+	AuthUserAgentInput,
+	InAppMessagingUserAgentInput,
+	GeoUserAgentInput,
+} from './Platform/types';
+export { setCustomUserAgent } from './Platform/customUserAgent';
+
+// Error handling
+export {
+	AmplifyError,
+	PlatformNotSupportedError,
+	createAssertionFunction,
+} from './errors';
+export {
+	AmplifyErrorCode,
+	AmplifyErrorMap,
+	AmplifyErrorParams,
+	AssertionFunction,
+	ServiceError,
+} from './types';
+
+// Other utilities & constants
+export { BackgroundProcessManager } from './BackgroundProcessManager';
+export { Mutex } from './Mutex';
+export { Reachability } from './Reachability';
+export {
+	INTERNAL_AWS_APPSYNC_REALTIME_PUBSUB_PROVIDER,
+	USER_AGENT_HEADER,
+} from './constants';
+export { fetchAuthSession } from './singleton/apis/internal/fetchAuthSession';
+export { AMPLIFY_SYMBOL } from './Hub';
+export { base64Decoder, base64Encoder } from './utils/convert';
+export { getCrypto } from './utils/globalHelpers';
+export { cryptoSecureRandomInt } from './utils/cryptoSecureRandomInt';
+export { WordArray };
+
+// Hub
+export { HubInternal } from './Hub';
+
+// Session listener
+export { sessionListener } from './utils/sessionListener';
+export { SessionState } from './utils/sessionListener/types';
+export {
+	SESSION_START_EVENT,
+	SESSION_STOP_EVENT,
+} from './utils/sessionListener';

package/src/parseAWSExports.ts

@@ -1,84 +1,300 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { AmplifyConfig } from './types';
 import { ConsoleLogger as Logger } from './Logger';
+import {
+	OAuthConfig,
+	AuthConfigUserAttributes,
+	OAuthProvider,
+} from './singleton/Auth/types';
+import { ResourcesConfig } from './singleton/types';
 
-const logger = new Logger('Parser');
+const logger = new Logger('parseAWSExports');
+
+const authTypeMapping: Record<any, any> = {
+	API_KEY: 'apiKey',
+	AWS_IAM: 'iam',
+	AMAZON_COGNITO_USER_POOLS: 'userPool',
+	OPENID_CONNECT: 'oidc',
+	NONE: 'none',
+	LAMBDA: 'lambda',
+};
+
+/**
+ * This utility converts the `aws-exports.js` file generated by the Amplify CLI into a {@link ResourcesConfig} object
+ * consumable by Amplify.
+ *
+ * @param config A configuration object from `aws-exports.js`.
+ *
+ * @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_bots,
+		aws_bots_config,
+		aws_cognito_identity_pool_id,
+		aws_cognito_sign_up_verification_method,
+		aws_cognito_mfa_configuration,
+		aws_cognito_mfa_types,
+		aws_cognito_password_protection_settings,
+		aws_cognito_verification_mechanisms,
+		aws_cognito_signup_attributes,
+		aws_cognito_social_providers,
+		aws_cognito_username_attributes,
+		aws_mandatory_sign_in,
+		aws_mobile_analytics_app_id,
+		aws_mobile_analytics_app_region,
+		aws_user_files_s3_bucket,
+		aws_user_files_s3_bucket_region,
+		aws_user_files_s3_dangerously_connect_to_http_endpoint_for_testing,
+		aws_user_pools_id,
+		aws_user_pools_web_client_id,
+		geo,
+		oauth,
+		predictions,
+		aws_cloud_logic_custom,
+		Notifications,
+	} = config;
+	const amplifyConfig: ResourcesConfig = {};
 
-export const parseAWSExports = (config): AmplifyConfig => {
-	const amplifyConfig: AmplifyConfig = {};
 	// Analytics
-	if (config['aws_mobile_analytics_app_id']) {
-		const Analytics = {
-			AWSPinpoint: {
-				appId: config['aws_mobile_analytics_app_id'],
-				region: config['aws_mobile_analytics_app_region'],
+	if (aws_mobile_analytics_app_id) {
+		amplifyConfig.Analytics = {
+			Pinpoint: {
+				appId: aws_mobile_analytics_app_id,
+				region: aws_mobile_analytics_app_region,
+			},
+		};
+	}
+
+	// Notifications
+	const { InAppMessaging, Push } = Notifications ?? {};
+	if (InAppMessaging?.AWSPinpoint || Push?.AWSPinpoint) {
+		amplifyConfig.Notifications = {};
+		if (InAppMessaging?.AWSPinpoint) {
+			const { appId, region } = InAppMessaging.AWSPinpoint;
+			amplifyConfig.Notifications.InAppMessaging = {
+				Pinpoint: {
+					appId,
+					region,
+				},
+			};
+		}
+		if (Push?.AWSPinpoint) {
+			const { appId, region } = Push.AWSPinpoint;
+			amplifyConfig.Notifications.PushNotification = {
+				Pinpoint: {
+					appId,
+					region,
+				},
+			};
+		}
+	}
+
+	// Interactions
+	if (Array.isArray(aws_bots_config)) {
+		amplifyConfig.Interactions = {
+			LexV1: Object.fromEntries(aws_bots_config.map(bot => [bot.name, bot])),
+		};
+	}
+
+	// API
+	if (aws_appsync_graphqlEndpoint) {
+		const defaultAuthMode = authTypeMapping[aws_appsync_authenticationType];
+		if (!defaultAuthMode) {
+			logger.debug(
+				`Invalid authentication type ${aws_appsync_authenticationType}. Falling back to IAM.`
+			);
+		}
+		amplifyConfig.API = {
+			GraphQL: {
+				endpoint: aws_appsync_graphqlEndpoint,
+				apiKey: aws_appsync_apiKey,
+				region: aws_appsync_region,
+				defaultAuthMode: defaultAuthMode ?? 'iam',
 			},
 		};
-		amplifyConfig.Analytics = Analytics;
 	}
 
 	// Auth
-	if (config['aws_cognito_identity_pool_id'] || config['aws_user_pools_id']) {
+	const mfaConfig = aws_cognito_mfa_configuration
+		? {
+				status:
+					aws_cognito_mfa_configuration &&
+					aws_cognito_mfa_configuration.toLowerCase(),
+				totpEnabled: aws_cognito_mfa_types?.includes('TOTP') ?? false,
+				smsEnabled: aws_cognito_mfa_types?.includes('SMS') ?? false,
+		  }
+		: undefined;
+	const passwordFormatConfig = aws_cognito_password_protection_settings
+		? {
+				minLength:
+					aws_cognito_password_protection_settings.passwordPolicyMinLength,
+				requireLowercase:
+					aws_cognito_password_protection_settings.passwordPolicyCharacters?.includes(
+						'REQUIRES_LOWERCASE'
+					) ?? false,
+				requireUppercase:
+					aws_cognito_password_protection_settings.passwordPolicyCharacters?.includes(
+						'REQUIRES_UPPERCASE'
+					) ?? false,
+				requireNumbers:
+					aws_cognito_password_protection_settings.passwordPolicyCharacters?.includes(
+						'REQUIRES_NUMBERS'
+					) ?? false,
+				requireSpecialCharacters:
+					aws_cognito_password_protection_settings.passwordPolicyCharacters?.includes(
+						'REQUIRES_SYMBOLS'
+					) ?? false,
+		  }
+		: undefined;
+	const mergedUserAttributes = Array.from(
+		new Set([
+			...(aws_cognito_verification_mechanisms ?? []),
+			...(aws_cognito_signup_attributes ?? []),
+		])
+	);
+	const userAttributesConfig = mergedUserAttributes.map((s: string) => ({
+		[s.toLowerCase()]: {
+			required: true, // All user attributes generated by the CLI will be required
+		},
+	})) as unknown as AuthConfigUserAttributes;
+	const loginWithEmailEnabled =
+		aws_cognito_username_attributes?.includes('EMAIL') ?? false;
+	const loginWithPhoneEnabled =
+		aws_cognito_username_attributes?.includes('PHONE_NUMBER') ?? false;
+	if (aws_cognito_identity_pool_id || aws_user_pools_id) {
 		amplifyConfig.Auth = {
-			userPoolId: config['aws_user_pools_id'],
-			userPoolWebClientId: config['aws_user_pools_web_client_id'],
-			region: config['aws_cognito_region'],
-			identityPoolId: config['aws_cognito_identity_pool_id'],
-			identityPoolRegion: config['aws_cognito_region'],
-			mandatorySignIn: config['aws_mandatory_sign_in'] === 'enable',
-			signUpVerificationMethod:
-				config['aws_cognito_sign_up_verification_method'] || 'code',
+			Cognito: {
+				identityPoolId: aws_cognito_identity_pool_id,
+				allowGuestAccess: aws_mandatory_sign_in !== 'enable',
+				signUpVerificationMethod: aws_cognito_sign_up_verification_method,
+				userAttributes: userAttributesConfig,
+				userPoolClientId: aws_user_pools_web_client_id,
+				userPoolId: aws_user_pools_id,
+				mfa: mfaConfig,
+				passwordFormat: passwordFormatConfig,
+				loginWith: {
+					username:
+						loginWithEmailEnabled || loginWithPhoneEnabled ? false : true,
+					email: loginWithEmailEnabled,
+					phone: loginWithPhoneEnabled,
+				},
+			},
+		};
+	}
+
+	const hasOAuthConfig = oauth ? Object.keys(oauth).length > 0 : false;
+	const hasSocialProviderConfig = aws_cognito_social_providers
+		? aws_cognito_social_providers.length > 0
+		: false;
+	if (amplifyConfig.Auth && hasOAuthConfig) {
+		amplifyConfig.Auth.Cognito.loginWith = {
+			...amplifyConfig.Auth.Cognito.loginWith,
+			oauth: {
+				...getOAuthConfig(oauth),
+				...(hasSocialProviderConfig && {
+					providers: parseSocialProviders(aws_cognito_social_providers),
+				}),
+			},
 		};
 	}
 
 	// Storage
-	let storageConfig;
-	if (config['aws_user_files_s3_bucket']) {
-		storageConfig = {
-			AWSS3: {
-				bucket: config['aws_user_files_s3_bucket'],
-				region: config['aws_user_files_s3_bucket_region'],
+	if (aws_user_files_s3_bucket) {
+		amplifyConfig.Storage = {
+			S3: {
+				bucket: aws_user_files_s3_bucket,
+				region: aws_user_files_s3_bucket_region,
 				dangerouslyConnectToHttpEndpointForTesting:
-					config[
-						'aws_user_files_s3_dangerously_connect_to_http_endpoint_for_testing'
-					],
+					aws_user_files_s3_dangerously_connect_to_http_endpoint_for_testing,
 			},
 		};
-	} else {
-		storageConfig = config ? config.Storage || config : {};
 	}
 
-	// Logging
-	if (config['Logging']) {
-		amplifyConfig.Logging = {
-			...config['Logging'],
-			region: config['aws_project_region'],
+	// Geo
+	if (geo) {
+		const { amazon_location_service } = geo;
+		(amplifyConfig as any).Geo = amazon_location_service
+			? {
+					LocationService: {
+						...amazon_location_service,
+						searchIndices: amazon_location_service.search_indices,
+						region: amazon_location_service.region,
+					},
+			  }
+			: { ...geo };
+	}
+
+	// REST API
+	if (aws_cloud_logic_custom) {
+		amplifyConfig.API = {
+			...amplifyConfig.API,
+			REST: (aws_cloud_logic_custom as any[]).reduce(
+				(acc, api: Record<string, any>) => {
+					const { name, endpoint, region, service } = api;
+					return {
+						...acc,
+						[name]: {
+							endpoint,
+							...(service ? { service } : undefined),
+							...(region ? { region } : undefined),
+						},
+					};
+				},
+				{}
+			),
 		};
 	}
 
-	// Geo
-	if (config['geo']) {
-		amplifyConfig.Geo = Object.assign({}, config.geo);
-		if (config.geo['amazon_location_service']) {
-			amplifyConfig.Geo = {
-				AmazonLocationService: config.geo['amazon_location_service'],
-			};
-		}
+	// Predictions
+	if (predictions) {
+		// map VoiceId from speechGenerator defaults to voiceId
+		const { VoiceId: voiceId } =
+			predictions?.convert?.speechGenerator?.defaults ?? {};
+		amplifyConfig.Predictions = voiceId
+			? {
+					...predictions,
+					convert: {
+						...predictions.convert,
+						speechGenerator: {
+							...predictions.convert.speechGenerator,
+							defaults: { voiceId },
+						},
+					},
+			  }
+			: predictions;
 	}
 
-	amplifyConfig.Analytics = Object.assign(
-		{},
-		amplifyConfig.Analytics,
-		config.Analytics
-	);
-	amplifyConfig.Auth = Object.assign({}, amplifyConfig.Auth, config.Auth);
-	amplifyConfig.Storage = Object.assign({}, storageConfig);
-	amplifyConfig.Logging = Object.assign(
-		{},
-		amplifyConfig.Logging,
-		config.Logging
-	);
-	logger.debug('parse config', config, 'to amplifyconfig', amplifyConfig);
 	return amplifyConfig;
 };
+
+const getRedirectUrl = (redirectStr: string): string[] =>
+	redirectStr.split(',');
+
+const getOAuthConfig = ({
+	domain,
+	scope,
+	redirectSignIn,
+	redirectSignOut,
+	responseType,
+}: Record<string, any>): OAuthConfig => ({
+	domain,
+	scopes: scope,
+	redirectSignIn: getRedirectUrl(redirectSignIn),
+	redirectSignOut: getRedirectUrl(redirectSignOut),
+	responseType,
+});
+
+const parseSocialProviders = (aws_cognito_social_providers: string[]) => {
+	return aws_cognito_social_providers.map((provider: string) => {
+		const updatedProvider = provider.toLowerCase();
+		return updatedProvider.charAt(0).toUpperCase() + updatedProvider.slice(1);
+	}) as OAuthProvider[];
+};

package/src/providers/kinesis/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 './kinesis';

package/src/providers/kinesis/types/kinesis.ts

@@ -0,0 +1,12 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export type KinesisProviderConfig = {
+	Kinesis: {
+		region: string;
+		bufferSize?: number;
+		flushSize?: number;
+		flushInterval?: number;
+		resendLimit?: number;
+	};
+};

package/src/providers/kinesis-firehose/types/index.ts

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

package/src/providers/kinesis-firehose/types/kinesis-firehose.ts

@@ -0,0 +1,12 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export type KinesisFirehoseProviderConfig = {
+	KinesisFirehose: {
+		region: string;
+		bufferSize?: number;
+		flushSize?: number;
+		flushInterval?: number;
+		resendLimit?: number;
+	};
+};

package/src/providers/personalize/types/index.ts

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

package/src/providers/personalize/types/personalize.ts

@@ -0,0 +1,11 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export type PersonalizeProviderConfig = {
+	Personalize: {
+		trackingId: string;
+		region: string;
+		flushSize?: number;
+		flushInterval?: number;
+	};
+};

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

@@ -0,0 +1,31 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { AWSCredentials } from '../../../libraryUtils';
+import { getEventBuffer } from '../utils/getEventBuffer';
+import {
+	BUFFER_SIZE,
+	FLUSH_INTERVAL,
+	FLUSH_SIZE,
+	RESEND_LIMIT,
+} from '../utils/constants';
+
+export const flushEvents = (
+	appId: string,
+	region: string,
+	credentials: AWSCredentials,
+	identityId?: string,
+	userAgentValue?: string
+) => {
+	getEventBuffer({
+		appId,
+		bufferSize: BUFFER_SIZE,
+		credentials,
+		flushInterval: FLUSH_INTERVAL,
+		flushSize: FLUSH_SIZE,
+		identityId,
+		region,
+		resendLimit: RESEND_LIMIT,
+		userAgentValue,
+	}).flushAll();
+};

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

@@ -0,0 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { updateEndpoint } from './updateEndpoint';
+export { record } from './record';
+export { flushEvents } from './flushEvents';

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

@@ -0,0 +1,93 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { amplifyUuid } from '../../../utils/amplifyUuid';
+import { PinpointRecordInput, PinpointSession } from '../types';
+import { resolveEndpointId } from '../utils';
+import {
+	SESSION_START_EVENT,
+	SESSION_STOP_EVENT,
+} from '../../../utils/sessionListener';
+import {
+	BUFFER_SIZE,
+	FLUSH_INTERVAL,
+	FLUSH_SIZE,
+	RESEND_LIMIT,
+} from '../utils/constants';
+import { getEventBuffer } from '../utils/getEventBuffer';
+
+let session: PinpointSession | undefined;
+
+/**
+ * @internal
+ */
+export const record = async ({
+	appId,
+	category,
+	channelType,
+	credentials,
+	event,
+	identityId,
+	region,
+	userAgentValue,
+}: PinpointRecordInput): Promise<void> => {
+	let eventSession = session;
+	const currentTime = new Date();
+	const timestampISOString = currentTime.toISOString();
+	const eventId = amplifyUuid();
+
+	// Prepare event buffer if required
+	const buffer = getEventBuffer({
+		appId,
+		bufferSize: BUFFER_SIZE,
+		credentials,
+		flushInterval: FLUSH_INTERVAL,
+		flushSize: FLUSH_SIZE,
+		identityId,
+		region,
+		resendLimit: RESEND_LIMIT,
+		userAgentValue,
+	});
+
+	const endpointId = await resolveEndpointId({
+		appId,
+		category,
+		channelType,
+		credentials,
+		identityId,
+		region,
+		userAgentValue,
+	});
+
+	// Generate session if required
+	if (!eventSession || event.name === SESSION_START_EVENT) {
+		const sessionId = amplifyUuid();
+
+		session = {
+			Id: sessionId,
+			StartTimestamp: timestampISOString,
+		};
+		eventSession = session;
+	}
+
+	// Terminate session when required
+	if (session && event.name === SESSION_STOP_EVENT) {
+		eventSession = {
+			...session,
+			StopTimestamp: timestampISOString,
+			Duration:
+				currentTime.getTime() - new Date(session.StartTimestamp).getTime(),
+		};
+		session = undefined;
+	}
+
+	// Push event to buffer
+	buffer.push({
+		eventId,
+		endpointId,
+		event,
+		session: eventSession!,
+		timestamp: timestampISOString,
+		resendLimit: RESEND_LIMIT,
+	});
+};