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

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

@@ -6,13 +6,14 @@ import { UserProfile } from '../../../types';
 
 export type SupportedCategory =
 	| 'Analytics'
+	| 'Core'
 	| 'InAppMessaging'
 	| 'PushNotification';
 
-export type SupportedChannelType = 'APNS' | 'APNS_SANDBOX' | 'GCM' | 'IN_APP';
+type SupportedChannelType = 'APNS' | 'APNS_SANDBOX' | 'GCM' | 'IN_APP';
 
 export type PinpointProviderConfig = {
-	Pinpoint: {
+	Pinpoint?: {
 		appId: string;
 		region: string;
 	};
@@ -21,6 +22,7 @@ export type PinpointProviderConfig = {
 export type PinpointServiceOptions = {
 	address?: string;
 	optOut?: 'ALL' | 'NONE';
+	userAttributes?: Record<string, string[]>;
 };
 
 export type PinpointSession = {
@@ -38,6 +40,7 @@ export type PinpointAnalyticsEvent = {
 type PinpointCommonParameters = {
 	appId: string;
 	category: SupportedCategory;
+	channelType?: SupportedChannelType;
 	credentials: Required<AuthSession>['credentials'];
 	identityId?: AuthSession['identityId'];
 	region: string;
@@ -46,7 +49,6 @@ type PinpointCommonParameters = {
 
 export type PinpointUpdateEndpointInput = PinpointCommonParameters &
 	PinpointServiceOptions & {
-		channelType?: SupportedChannelType;
 		userId?: string;
 		userProfile?: UserProfile;
 	};

package/src/providers/pinpoint/utils/PinpointEventBuffer.ts

@@ -7,15 +7,15 @@ import {
 	putEvents,
 	PutEventsInput,
 	PutEventsOutput,
-} from '../../../AwsClients/Pinpoint';
-import { 
+} from '../../../awsClients/pinpoint';
+import {
 	EventBufferConfig,
 	BufferedEvent,
 	BufferedEventMap,
-	EventBuffer
+	EventBuffer,
 } from '../types/buffer';
 import { AuthSession } from '../../../singleton/Auth/types';
-import { isAppInForeground } from '../../../RNComponents/isAppInForeground';
+import { isAppInForeground } from './isAppInForeground';
 
 const logger = new Logger('PinpointEventBuffer');
 const RETRYABLE_CODES = [429, 500];
@@ -39,7 +39,9 @@ export class PinpointEventBuffer {
 
 	public push(event: BufferedEvent) {
 		if (this._buffer.length >= this._config.bufferSize) {
-			logger.debug('Exceeded Pinpoint event buffer limits, event dropped.', { eventId: event.eventId });
+			logger.debug('Exceeded Pinpoint event buffer limits, event dropped.', {
+				eventId: event.eventId,
+			});
 
 			return;
 		}
@@ -63,6 +65,10 @@ export class PinpointEventBuffer {
 		return this._config.identityId !== identityId;
 	}
 
+	public flushAll() {
+		this._putEvents(this._buffer.splice(0, this._buffer.length));
+	}
+
 	private _startLoop() {
 		if (this._interval) {
 			clearInterval(this._interval);
@@ -112,16 +118,18 @@ export class PinpointEventBuffer {
 		}
 	}
 
-	private _generateBatchEventParams(eventMap: BufferedEventMap): PutEventsInput {
+	private _generateBatchEventParams(
+		eventMap: BufferedEventMap
+	): PutEventsInput {
 		const batchItem: Record<string, EventsBatch> = {};
 
 		Object.values(eventMap).forEach(item => {
 			const { event, timestamp, endpointId, eventId, session } = item;
 			const { name, attributes, metrics } = event;
-	
+
 			batchItem[endpointId] = {
 				Endpoint: {
-					...batchItem[endpointId]?.Endpoint
+					...batchItem[endpointId]?.Endpoint,
 				},
 				Events: {
 					...batchItem[endpointId]?.Events,
@@ -131,11 +139,11 @@ export class PinpointEventBuffer {
 						Attributes: attributes,
 						Metrics: metrics,
 						Session: session,
-					}
+					},
 				},
 			};
 		});
-	
+
 		return {
 			ApplicationId: this._config.appId,
 			EventsRequest: {
@@ -200,7 +208,7 @@ export class PinpointEventBuffer {
 				logger.warn('Pinpoint event failed to send.', {
 					eventId,
 					name,
-					message: Message
+					message: Message,
 				});
 			});
 		});
@@ -222,7 +230,7 @@ export class PinpointEventBuffer {
 				logger.debug('Resending event.', {
 					eventId,
 					name,
-					remainingAttempts: bufferedEvent.resendLimit
+					remainingAttempts: bufferedEvent.resendLimit,
 				});
 				eligibleEvents.push({ [eventId!]: bufferedEvent });
 				return;
@@ -230,7 +238,7 @@ export class PinpointEventBuffer {
 
 			logger.debug('No retry attempts remaining for event.', {
 				eventId,
-				name
+				name,
 			});
 		});
 

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

@@ -4,3 +4,4 @@
 export { cacheEndpointId } from './cacheEndpointId';
 export { getCacheKey } from './getCacheKey';
 export { getEndpointId } from './getEndpointId';
+export { resolveEndpointId } from './resolveEndpointId';

package/src/providers/pinpoint/utils/isAppInForeground.native.ts

@@ -0,0 +1,7 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+// @ts-ignore: missing type definition
+import { AppState } from 'react-native';
+
+export const isAppInForeground = () => AppState.currentState === 'active';

package/src/providers/pinpoint/utils/isAppInForeground.ts

@@ -0,0 +1,4 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export const isAppInForeground = () => true;

package/src/providers/pinpoint/utils/resolveEndpointId.ts

@@ -0,0 +1,46 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { assert } from '../../../errors';
+import { AmplifyErrorCode } from '../../../types';
+import { updateEndpoint } from '../apis';
+import { PinpointUpdateEndpointInput } from '../types';
+import { getEndpointId } from './getEndpointId';
+
+/**
+ * Resolves an endpoint id from cache or prepare via updateEndpoint if one does not already exist,
+ * which will generate and cache an endpoint id between calls.
+ *
+ * @internal
+ */
+export const resolveEndpointId = async ({
+	address,
+	appId,
+	category,
+	channelType,
+	credentials,
+	identityId,
+	region,
+	userAgentValue,
+}: PinpointUpdateEndpointInput) => {
+	let endpointId = await getEndpointId(appId, category);
+
+	if (!endpointId) {
+		await updateEndpoint({
+			address,
+			appId,
+			category,
+			channelType,
+			credentials,
+			identityId,
+			region,
+			userAgentValue,
+		});
+
+		endpointId = await getEndpointId(appId, category);
+	}
+
+	assert(!!endpointId, AmplifyErrorCode.NoEndpointId);
+
+	return endpointId;
+};

package/src/singleton/API/types.ts

@@ -0,0 +1,203 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { Headers } from '../../clients';
+
+export type LibraryAPIOptions = {
+	GraphQL?: {
+		// custom headers for given GraphQL service. Will be applied to all operations.
+		headers?: (options: {
+			query: string;
+			variables?: Record<string, DocumentType>;
+		}) => Promise<Headers>;
+		withCredentials?: boolean;
+	};
+	REST?: {
+		// custom headers for given REST service. Will be applied to all operations.
+		headers?: (options: { apiName: string }) => Promise<Headers>;
+	};
+};
+
+type APIGraphQLConfig = {
+	/**
+	 * Required GraphQL endpoint, must be a valid URL string.
+	 */
+	endpoint: string;
+	/**
+	 * Optional region string used to sign the request. Required only if the auth mode is 'iam'.
+	 */
+	region?: string;
+	/**
+	 * Optional API key string. Required only if the auth mode is 'apiKey'.
+	 */
+	apiKey?: string;
+	/**
+	 * Custom domain endpoint for GraphQL API.
+	 */
+	customEndpoint?: string;
+	/**
+	 * Optional region string used to sign the request to `customEndpoint`. Effective only if `customEndpoint` is
+	 * specified, and the auth mode is 'iam'.
+	 */
+	customEndpointRegion?: string;
+	/**
+	 * Default auth mode for all the API calls to given service.
+	 */
+	defaultAuthMode: GraphQLAuthMode;
+	modelIntrospection?: ModelIntrospectionSchema;
+};
+
+type APIRestConfig = {
+	/**
+	 * Required REST endpoint, must be a valid URL string.
+	 */
+	endpoint: string;
+	/**
+	 * Optional region string used to sign the request with IAM credentials. If Omitted, region will be extracted from
+	 * the endpoint.
+	 *
+	 * @default 'us-east-1'
+	 */
+	region?: string;
+	/**
+	 * Optional service name string to sign the request with IAM credentials.
+	 *
+	 * @default 'execute-api'
+	 */
+	service?: string;
+};
+
+export type APIConfig = {
+	REST?: Record<string, APIRestConfig>;
+	GraphQL?: APIGraphQLConfig;
+};
+
+export type GraphQLAuthMode =
+	| 'apiKey'
+	| 'oidc'
+	| 'userPool'
+	| 'iam'
+	| 'lambda'
+	| 'none';
+
+/**
+ * Type representing a plain JavaScript object that can be serialized to JSON.
+ */
+export type DocumentType =
+	| null
+	| boolean
+	| number
+	| string
+	| DocumentType[]
+	| { [prop: string]: DocumentType };
+
+/**
+ * Root model instrospection schema shape.
+ *
+ * Borrowed from: https://github.com/aws-amplify/samsara-cli/pull/377/commits/c08ea2c1a43f36aafe63b6d14d03f884e9c0c671#diff-21ae6faa2f22c15bb25ff9b272eaab7846c0650e2d267ab720546c19559583d0R4-R108
+ */
+export type ModelIntrospectionSchema = {
+	version: 1;
+	models: SchemaModels;
+	nonModels: SchemaNonModels;
+	enums: SchemaEnums;
+};
+
+/**
+ * Top-level Entities on a Schema
+ */
+export type SchemaModels = Record<string, SchemaModel>;
+export type SchemaNonModels = Record<string, SchemaNonModel>;
+export type SchemaEnums = Record<string, SchemaEnum>;
+
+export type SchemaModel = {
+	name: string;
+	attributes?: ModelAttribute[];
+	fields: Fields;
+	pluralName: string;
+	syncable?: boolean;
+	primaryKeyInfo: PrimaryKeyInfo;
+};
+export type SchemaNonModel = {
+	name: string;
+	fields: Fields;
+};
+export type SchemaEnum = {
+	name: string;
+	values: string[];
+};
+
+export type ModelAttribute = {
+	type: string;
+	properties?: { [key: string]: any };
+};
+
+/**
+ * Field Definition
+ */
+export type Fields = Record<string, Field>;
+export type Field = {
+	name: string;
+	type: FieldType;
+	isArray: boolean;
+	isRequired: boolean;
+	isReadOnly?: boolean;
+	isArrayNullable?: boolean;
+	attributes?: FieldAttribute[];
+	association?: AssociationType;
+};
+export type FieldType =
+	| 'ID'
+	| 'String'
+	| 'Int'
+	| 'Float'
+	| 'AWSDate'
+	| 'AWSTime'
+	| 'AWSDateTime'
+	| 'AWSTimestamp'
+	| 'AWSEmail'
+	| 'AWSURL'
+	| 'AWSIPAddress'
+	| 'Boolean'
+	| 'AWSJSON'
+	| 'AWSPhone'
+	| { enum: string }
+	| { model: string }
+	| { nonModel: string };
+export type FieldAttribute = ModelAttribute;
+
+/**
+ * Field-level Relationship Definitions
+ */
+export enum CodeGenConnectionType {
+	HAS_ONE = 'HAS_ONE',
+	BELONGS_TO = 'BELONGS_TO',
+	HAS_MANY = 'HAS_MANY',
+}
+export type AssociationBaseType = {
+	connectionType: CodeGenConnectionType;
+};
+
+export type AssociationHasMany = AssociationBaseType & {
+	connectionType: CodeGenConnectionType.HAS_MANY;
+	associatedWith: string[];
+};
+export type AssociationHasOne = AssociationBaseType & {
+	connectionType: CodeGenConnectionType.HAS_ONE;
+	associatedWith: string[];
+	targetNames: string[];
+};
+
+export type AssociationBelongsTo = AssociationBaseType & {
+	connectionType: CodeGenConnectionType.BELONGS_TO;
+	targetNames: string[];
+};
+export type AssociationType =
+	| AssociationHasMany
+	| AssociationHasOne
+	| AssociationBelongsTo;
+
+export type PrimaryKeyInfo = {
+	isCustomPrimaryKey: boolean;
+	primaryKeyFieldName: string;
+	sortKeyFieldNames: string[];
+};

package/src/singleton/Amplify.ts

@@ -4,24 +4,23 @@ import { AuthClass } from './Auth';
 import { Hub, AMPLIFY_SYMBOL } from '../Hub';
 import { LegacyConfig, LibraryOptions, ResourcesConfig } from './types';
 import { parseAWSExports } from '../parseAWSExports';
-
-// TODO(v6): add default AuthTokenStore for each platform
+import { deepFreeze } from '../utils';
 
 export class AmplifyClass {
 	resourcesConfig: ResourcesConfig;
 	libraryOptions: LibraryOptions;
+
 	/**
 	 * Cross-category Auth utilities.
 	 *
 	 * @internal
 	 */
 	public readonly Auth: AuthClass;
+
 	constructor() {
 		this.resourcesConfig = {};
-		this.Auth = new AuthClass();
-
-		// TODO(v6): add default providers for getting started
 		this.libraryOptions = {};
+		this.Auth = new AuthClass();
 	}
 
 	/**
@@ -55,6 +54,9 @@ export class AmplifyClass {
 			libraryOptions
 		);
 
+		// Make resource config immutable
+		this.resourcesConfig = deepFreeze(this.resourcesConfig);
+
 		this.Auth.configure(this.resourcesConfig.Auth!, this.libraryOptions.Auth);
 
 		Hub.dispatch(
@@ -71,10 +73,10 @@ export class AmplifyClass {
 	/**
 	 * Provides access to the current back-end resource configuration for the Library.
 	 *
-	 * @returns Returns the current back-end resource configuration.
+	 * @returns Returns the immutable back-end resource configuration.
 	 */
-	getConfig(): ResourcesConfig {
-		return JSON.parse(JSON.stringify(this.resourcesConfig));
+	getConfig(): Readonly<ResourcesConfig> {
+		return this.resourcesConfig;
 	}
 }
 

package/src/singleton/Analytics/types.ts

@@ -2,5 +2,11 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { PinpointProviderConfig } from '../../providers/pinpoint/types';
+import { KinesisProviderConfig } from '../../providers/kinesis/types';
+import { KinesisFirehoseProviderConfig } from '../../providers/kinesis-firehose/types';
+import { PersonalizeProviderConfig } from '../../providers/personalize/types';
 
-export type AnalyticsConfig = PinpointProviderConfig;
+export type AnalyticsConfig = PinpointProviderConfig &
+	KinesisProviderConfig &
+	KinesisFirehoseProviderConfig &
+	PersonalizeProviderConfig;

package/src/singleton/Auth/types.ts

@@ -20,7 +20,7 @@ type Json = null | string | number | boolean | Json[] | JsonObject;
 /** JSON Object type */
 type JsonObject = { [name: string]: Json };
 
-type JwtPayload = JwtPayloadStandardFields & JsonObject;
+export type JwtPayload = JwtPayloadStandardFields & JsonObject;
 
 export type JWT = {
 	payload: JwtPayload;
@@ -70,6 +70,33 @@ export type AuthTokens = {
 	accessToken: JWT;
 };
 
+export type AuthStandardAttributeKey =
+	| 'address'
+	| 'birthdate'
+	| 'email_verified'
+	| 'family_name'
+	| 'gender'
+	| 'given_name'
+	| 'locale'
+	| 'middle_name'
+	| 'name'
+	| 'nickname'
+	| 'phone_number_verified'
+	| 'picture'
+	| 'preferred_username'
+	| 'profile'
+	| 'sub'
+	| 'updated_at'
+	| 'website'
+	| 'zoneinfo'
+	| AuthVerifiableAttributeKey;
+
+export type AuthVerifiableAttributeKey = 'email' | 'phone_number';
+
+export type AuthConfigUserAttributes = Partial<
+	Record<AuthStandardAttributeKey, { required: boolean }>
+>;
+
 export type AuthConfig = StrictUnion<
 	| AuthIdentityPoolConfig
 	| AuthUserPoolConfig
@@ -86,7 +113,12 @@ export type AuthIdentityPoolConfig = {
 	Cognito: CognitoIdentityPoolConfig & {
 		userPoolClientId?: never;
 		userPoolId?: never;
+		userPoolEndpoint?: never;
 		loginWith?: never;
+		signUpVerificationMethod?: never;
+		userAttributes?: never;
+		mfa?: never;
+		passwordFormat?: never;
 	};
 };
 
@@ -105,9 +137,26 @@ export type AuthUserPoolConfig = {
 export type CognitoUserPoolConfig = {
 	userPoolClientId: string;
 	userPoolId: string;
+	userPoolEndpoint?: string;
 	signUpVerificationMethod?: 'code' | 'link';
 	loginWith?: {
 		oauth?: OAuthConfig;
+		username?: boolean;
+		email?: boolean;
+		phone?: boolean;
+	};
+	userAttributes?: AuthConfigUserAttributes;
+	mfa?: {
+		status?: 'on' | 'off' | 'optional';
+		totpEnabled?: boolean;
+		smsEnabled?: boolean;
+	};
+	passwordFormat?: {
+		minLength?: number;
+		requireLowercase?: boolean;
+		requireUppercase?: boolean;
+		requireNumbers?: boolean;
+		requireSpecialCharacters?: boolean;
 	};
 };
 
@@ -168,7 +217,7 @@ export type AWSCredentialsAndIdentityId = {
 	identityId?: string;
 };
 
-type AWSCredentials = {
+export type AWSCredentials = {
 	accessKeyId: string;
 	secretAccessKey: string;
 	sessionToken?: string;

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

@@ -0,0 +1,37 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { createAssertionFunction } from '../../../errors';
+import { AmplifyErrorMap, AssertionFunction } from '../../../types';
+
+export enum AuthConfigurationErrorCode {
+	AuthTokenConfigException = 'AuthTokenConfigException',
+	AuthUserPoolAndIdentityPoolException = 'AuthUserPoolAndIdentityPoolException',
+	InvalidIdentityPoolIdException = 'InvalidIdentityPoolIdException',
+	OAuthNotConfigureException = 'OAuthNotConfigureException',
+}
+
+const authConfigurationErrorMap: AmplifyErrorMap<AuthConfigurationErrorCode> = {
+	[AuthConfigurationErrorCode.AuthTokenConfigException]: {
+		message: 'Auth Token Provider not configured.',
+		recoverySuggestion: 'Make sure to call Amplify.configure in your app.',
+	},
+	[AuthConfigurationErrorCode.AuthUserPoolAndIdentityPoolException]: {
+		message: 'Auth UserPool or IdentityPool not configured.',
+		recoverySuggestion:
+			'Make sure to call Amplify.configure in your app with UserPoolId and IdentityPoolId.',
+	},
+	[AuthConfigurationErrorCode.InvalidIdentityPoolIdException]: {
+		message: 'Invalid identity pool id provided.',
+		recoverySuggestion:
+			'Make sure a valid identityPoolId is given in the config.',
+	},
+	[AuthConfigurationErrorCode.OAuthNotConfigureException]: {
+		message: 'oauth param not configured.',
+		recoverySuggestion:
+			'Make sure to call Amplify.configure with oauth parameter in your app.',
+	},
+};
+
+export const assert: AssertionFunction<AuthConfigurationErrorCode> =
+	createAssertionFunction(authConfigurationErrorMap);