@aws-amplify/core 6.0.1-preview-testing.be90020.0 → 6.0.1-server-generate-client.1e317a1.0

package/src/libraryUtils.ts

@@ -5,44 +5,45 @@
 This file maps top-level exports from `@aws-amplify/core/internals/utils`. These are intended to be internal
 utils for use throughout the library.
 */
-// JS utilities
+// Core utilities
 export {
-	isBrowser,
-	filenameToContentType,
 	generateRandomString,
-	isEmpty,
-	isStrictObject,
-	isTextFile,
+	isBrowser,
+	isNonRetryableError,
 	isWebWorker,
-	makeQuerablePromise,
-	objectLessAttributes,
-	sortByField,
-	transferKeyToLowerCase,
-	transferKeyToUpperCase,
-} from './Util/JS';
+	jitteredBackoff,
+	jitteredExponentialRetry,
+	NonRetryableError,
+	retry,
+	urlSafeDecode,
+	urlSafeEncode,
+} from './utils';
 export { parseAWSExports } from './parseAWSExports';
 export { LegacyConfig } from './singleton/types';
-export {
-	JWT,
-	StrictUnion,
-	CognitoIdentityPoolConfig,
-} from './singleton/Auth/types';
+export { amplifyUuid } from './utils/amplifyUuid';
+export { AmplifyUrl, AmplifyUrlSearchParams } from './utils/amplifyUrl';
+
 // Auth utilities
 export {
 	decodeJWT,
 	assertTokenProviderConfig,
-	assertIdentityPooIdConfig,
+	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';
 
-// Logging utilities
-export { ConsoleLogger, ConsoleLogger as Logger } from './Logger';
-
-// Platform & device utils
-import { Platform } from './Platform';
-export { ClientDevice } from './ClientDevice';
+// Platform & user-agent utilities
 export {
 	Platform,
 	getAmplifyUserAgentObject,
@@ -63,45 +64,44 @@ export {
 	PubSubAction,
 	PushNotificationAction,
 	StorageAction,
+	SetCustomUserAgentInput,
+	StorageUserAgentInput,
+	AuthUserAgentInput,
+	InAppMessagingUserAgentInput,
+	GeoUserAgentInput,
 } from './Platform/types';
-export const Constants = {
-	userAgent: Platform.userAgent,
-};
+export { setCustomUserAgent } from './Platform/customUserAgent';
 
-// Service worker
-export { ServiceWorker } from './ServiceWorker';
-
-// Other utilities & constants
-export {
-	AWS_CLOUDWATCH_CATEGORY,
-	BackgroundManagerNotOpenError,
-	BackgroundProcessManager,
-	BackgroundProcessManagerState,
-	DateUtils,
-	Mutex,
-	NO_CREDS_ERROR_STRING,
-	NonRetryableError,
-	RETRY_ERROR_CODES,
-	Reachability,
-	isNonRetryableError,
-	jitteredBackoff,
-	jitteredExponentialRetry,
-	retry,
-	urlSafeDecode,
-	urlSafeEncode,
-} from './Util';
-export { asserts } from './Util/errors/AssertError';
+// Error handling
 export {
-	invalidParameter,
-	missingConfig,
 	AmplifyError,
-	AmplifyErrorString,
-} from './Util/Errors';
-export { AppState, AsyncStorage, Linking } from './RNComponents';
-export { ErrorParams, AmplifyErrorMap, ServiceError } from './types';
+	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 './Util/Constants';
+} 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';
+
+// Hub
+export { HubInternal } from './Hub';
+
+// Session listener
+export { sessionListener } from './utils/sessionListener';
+export { SessionState } from './utils/sessionListener/types';

package/src/parseAWSExports.ts

@@ -1,8 +1,25 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { OAuthConfig } from './singleton/Auth/types';
+import { ConsoleLogger as Logger } from './Logger';
+import {
+	OAuthConfig,
+	AuthStandardAttributeKey,
+	AuthConfigUserAttributes,
+} from './singleton/Auth/types';
+
 import { ResourcesConfig } from './singleton/types';
 
+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.
@@ -11,12 +28,25 @@ 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_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_username_attributes,
 		aws_mandatory_sign_in,
 		aws_mobile_analytics_app_id,
 		aws_mobile_analytics_app_region,
@@ -27,6 +57,9 @@ export const parseAWSExports = (
 		aws_user_pools_web_client_id,
 		geo,
 		oauth,
+		aws_cloud_logic_custom,
+		Notifications,
+		modelIntrospection,
 	} = config;
 	const amplifyConfig: ResourcesConfig = {};
 
@@ -40,19 +73,126 @@ export const parseAWSExports = (
 		};
 	}
 
+	// 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',
+			},
+		};
+		if (modelIntrospection) {
+			amplifyConfig.API.GraphQL!.modelIntrospection = modelIntrospection;
+		}
+	}
+
 	// Auth
+	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 = {
 			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,
-				...(oauth &&
-					Object.keys(oauth).length > 0 && {
-						loginWith: getOAuthConfig(oauth),
-					}),
+				mfa: mfaConfig,
+				passwordFormat: passwordFormatConfig,
+				loginWith: {
+					username:
+						loginWithEmailEnabled || loginWithPhoneEnabled ? false : true,
+					email: loginWithEmailEnabled,
+					phone: loginWithPhoneEnabled,
+					...(oauth &&
+						Object.keys(oauth).length > 0 && {
+							oauth: getOAuthConfig(oauth),
+						}),
+				},
 			},
 		};
 	}
@@ -73,10 +213,37 @@ export const parseAWSExports = (
 	if (geo) {
 		const { amazon_location_service } = geo;
 		(amplifyConfig as any).Geo = amazon_location_service
-			? { AmazonLocationService: 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),
+						},
+					};
+				},
+				{}
+			),
+		};
+	}
+
 	return amplifyConfig;
 };
 
@@ -89,12 +256,10 @@ const getOAuthConfig = ({
 	redirectSignIn,
 	redirectSignOut,
 	responseType,
-}: Record<string, any>): { oauth: OAuthConfig } => ({
-	oauth: {
-		domain,
-		scopes: scope,
-		redirectSignIn: getRedirectUrl(redirectSignIn),
-		redirectSignOut: getRedirectUrl(redirectSignOut),
-		responseType,
-	},
+}: Record<string, any>): OAuthConfig => ({
+	domain,
+	scopes: scope,
+	redirectSignIn: getRedirectUrl(redirectSignIn),
+	redirectSignOut: getRedirectUrl(redirectSignOut),
+	responseType,
 });

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

@@ -3,3 +3,4 @@
 
 export { updateEndpoint } from './updateEndpoint';
 export { record } from './record';
+export { flushEvents } from './flushEvents';

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

@@ -1,18 +1,16 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { v4 as uuid } from 'uuid';
+import { amplifyUuid } from '../../../utils/amplifyUuid';
 import { PinpointRecordInput, PinpointSession } from '../types';
-import { getEndpointId } from '../utils';
+import { resolveEndpointId } from '../utils';
 import {
 	BUFFER_SIZE,
 	FLUSH_INTERVAL,
 	FLUSH_SIZE,
 	RESEND_LIMIT,
 } from '../utils/constants';
-import { updateEndpoint } from './updateEndpoint';
 import { getEventBuffer } from '../utils/getEventBuffer';
-import { AmplifyError } from '../../../libraryUtils';
 
 // TODO(v6) Refactor when we add support for session tracking & `autoTrack`
 let session: PinpointSession;
@@ -23,6 +21,7 @@ let session: PinpointSession;
 export const record = async ({
 	appId,
 	category,
+	channelType,
 	credentials,
 	event,
 	identityId,
@@ -30,8 +29,7 @@ export const record = async ({
 	userAgentValue,
 }: PinpointRecordInput): Promise<void> => {
 	const timestampISOString = new Date().toISOString();
-	const eventId = uuid();
-	let endpointId = await getEndpointId(appId, category);
+	const eventId = amplifyUuid();
 
 	// Prepare event buffer if required
 	const buffer = getEventBuffer({
@@ -46,31 +44,19 @@ export const record = async ({
 		userAgentValue,
 	});
 
-	// Prepare a Pinpoint endpoint via updateEndpoint if one does not already exist, which will generate and cache an
-	// endpoint ID between calls
-	if (!endpointId) {
-		await updateEndpoint({
-			appId,
-			category,
-			credentials,
-			identityId,
-			region,
-			userAgentValue,
-		});
-
-		endpointId = await getEndpointId(appId, category);
-	}
-
-	if (!endpointId) {
-		throw new AmplifyError({
-			name: 'ENDPOINT_NOT_CREATED',
-			message: 'Endpoint was not created.',
-		});
-	}
+	const endpointId = await resolveEndpointId({
+		appId,
+		category,
+		channelType,
+		credentials,
+		identityId,
+		region,
+		userAgentValue,
+	});
 
 	// Generate session if required
 	if (!session) {
-		const sessionId = uuid();
+		const sessionId = amplifyUuid();
 
 		session = {
 			Id: sessionId,

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

@@ -1,12 +1,12 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { v4 as uuidv4 } from 'uuid';
-import { ClientDevice } from '../../../ClientDevice';
+import { amplifyUuid } from '../../../utils/amplifyUuid';
+import { getClientInfo } from '../../../utils/getClientInfo';
 import {
 	updateEndpoint as clientUpdateEndpoint,
 	UpdateEndpointInput,
-} from '../../../AwsClients/Pinpoint';
+} from '../../../awsClients/pinpoint';
 import { PinpointUpdateEndpointInput } from '../types';
 import { cacheEndpointId, getEndpointId } from '../utils';
 
@@ -22,15 +22,24 @@ export const updateEndpoint = async ({
 	identityId,
 	optOut,
 	region,
+	userAttributes,
 	userId,
 	userProfile,
 	userAgentValue,
 }: 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;
-	const { attributes, demographic, location, metrics } = userProfile ?? {};
-	const clientInfo = ClientDevice.clientInfo();
+	const createdEndpointId = !endpointId ? amplifyUuid() : undefined;
+	const {
+		customProperties,
+		demographic,
+		email,
+		location,
+		metrics,
+		name,
+		plan,
+	} = userProfile ?? {};
+	const clientInfo = getClientInfo();
 	const mergedDemographic = {
 		appVersion: clientInfo.appVersion,
 		make: clientInfo.make,
@@ -39,15 +48,22 @@ export const updateEndpoint = async ({
 		platform: clientInfo.platform,
 		...demographic,
 	};
+	const shouldAddAttributes = email || customProperties || name || plan;
+	const attributes = {
+		...(email && { email: [email] }),
+		...(name && { name: [name] }),
+		...(plan && { plan: [plan] }),
+		...customProperties,
+	};
 	const input: UpdateEndpointInput = {
 		ApplicationId: appId,
 		EndpointId: endpointId ?? createdEndpointId,
 		EndpointRequest: {
-			RequestId: uuidv4(),
+			RequestId: amplifyUuid(),
 			EffectiveDate: new Date().toISOString(),
 			ChannelType: channelType,
 			Address: address,
-			Attributes: attributes,
+			Attributes: shouldAddAttributes ? attributes : undefined,
 			Demographic: {
 				AppVersion: mergedDemographic.appVersion,
 				Locale: mergedDemographic.locale,
@@ -70,13 +86,13 @@ export const updateEndpoint = async ({
 			OptOut: optOut,
 			User: {
 				UserId: userId ?? identityId,
-				UserAttributes: attributes,
+				UserAttributes: userAttributes,
 			},
 		},
 	};
 	await clientUpdateEndpoint({ credentials, region, userAgentValue }, input);
 	// if we had to create an endpoint id, we need to now cache it
 	if (!!createdEndpointId) {
-		cacheEndpointId(appId, category, createdEndpointId);
+		return cacheEndpointId(appId, category, createdEndpointId);
 	}
 };

package/src/providers/pinpoint/index.ts

@@ -2,4 +2,9 @@
 // SPDX-License-Identifier: Apache-2.0
 
 export * from './apis';
-export { PinpointAnalyticsEvent, PinpointServiceOptions } from './types';
+export {
+	PinpointAnalyticsEvent,
+	PinpointServiceOptions,
+	UpdateEndpointException,
+} from './types';
+export { resolveEndpointId } from './utils';

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

@@ -0,0 +1,12 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export enum UpdateEndpointException {
+	BadRequestException = 'BadRequestException',
+	ForbiddenException = 'ForbiddenException',
+	InternalServerErrorException = 'InternalServerErrorException',
+	MethodNotAllowedException = 'MethodNotAllowedException',
+	NotFoundException = 'NotFoundException',
+	PayloadTooLargeException = 'PayloadTooLargeException',
+	TooManyRequestsException = 'TooManyRequestsException',
+}

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

@@ -1,4 +1,5 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+export { UpdateEndpointException } from './errors';
 export * from './pinpoint';