@aws-amplify/core 6.0.1-console-preview.f63250a.0 → 6.0.1-console-preview.5dc0b68.0

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

@@ -0,0 +1,60 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { EventBufferConfig } from '../types/buffer';
+import { PinpointEventBuffer } from './PinpointEventBuffer';
+import { BUFFER_SIZE, FLUSH_INTERVAL, FLUSH_SIZE, RESEND_LIMIT } from './constants';
+
+// Map of buffers by region -> appId
+const eventBufferMap: Record<string, Record<string, PinpointEventBuffer>> = {};
+
+/**
+ * Returns a PinpointEventBuffer instance for the specified region & app ID, creating one if it does not yet exist.
+ * 
+ * @internal
+ */
+export const getEventBuffer = ({
+	appId,
+	bufferSize = BUFFER_SIZE,
+	credentials,
+	flushInterval = FLUSH_INTERVAL,
+	flushSize = FLUSH_SIZE,
+	identityId,
+	region,
+	resendLimit = RESEND_LIMIT,
+	userAgentValue
+}: EventBufferConfig): PinpointEventBuffer => {
+	if (eventBufferMap[region]?.[appId]) {
+		const buffer = eventBufferMap[region][appId];
+
+		/*
+		If the identity has changed flush out the buffer and create a new instance. The old instance will be garbage 
+		collected.
+		*/
+		if (buffer.identityHasChanged(identityId)) {
+			buffer.flush();
+		} else {
+			return buffer;
+		}
+	}
+
+	const buffer = new PinpointEventBuffer({
+		appId,
+		bufferSize,
+		credentials,
+		flushInterval,
+		flushSize,
+		identityId,
+		region,
+		resendLimit,
+		userAgentValue
+	});
+
+	if (!eventBufferMap[region]) {
+		eventBufferMap[region] = {};
+	}
+
+	eventBufferMap[region][appId] = buffer;
+
+	return buffer;
+};

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

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

package/src/server.ts

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

package/src/singleton/Amplify.ts

@@ -0,0 +1,121 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { AuthClass } from './Auth';
+import { Hub, AMPLIFY_SYMBOL } from '../Hub';
+import { LibraryOptions, ResourcesConfig } from './types';
+
+// TODO(v6): add default AuthTokenStore for each platform
+
+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 = {};
+	}
+
+	/**
+	 * Configures Amplify for use with your back-end resources.
+	 *
+	 * @remarks
+	 * `configure` can be used to specify additional library options where available for supported categories.
+	 *
+	 * @param resourceConfig - Back-end resource configuration. Typically provided via the `aws-exports.js` file.
+	 * @param libraryOptions - Additional options for customizing the behavior of the library.
+	 */
+	configure(
+		resourcesConfig: ResourcesConfig,
+		libraryOptions: LibraryOptions = {}
+	): void {
+		this.resourcesConfig = mergeResourceConfig(
+			this.resourcesConfig,
+			resourcesConfig
+		);
+
+		this.libraryOptions = mergeLibraryOptions(
+			this.libraryOptions,
+			libraryOptions
+		);
+
+		this.Auth.configure(this.resourcesConfig.Auth!, this.libraryOptions.Auth);
+
+		Hub.dispatch(
+			'core',
+			{
+				event: 'configure',
+				data: resourcesConfig,
+			},
+			'Configure',
+			AMPLIFY_SYMBOL
+		);
+	}
+
+	/**
+	 * Provides access to the current back-end resource configuration for the Library.
+	 *
+	 * @returns Returns the current back-end resource configuration.
+	 */
+	getConfig(): ResourcesConfig {
+		return JSON.parse(JSON.stringify(this.resourcesConfig));
+	}
+}
+
+/**
+ * The `Amplify` utility is used to configure the library.
+ *
+ * @remarks
+ * `Amplify` is responsible for orchestrating cross-category communication within the library.
+ */
+export const Amplify = new AmplifyClass();
+
+// TODO(v6): validate until which level this will nested, during Amplify.configure API review.
+function mergeResourceConfig(
+	existingConfig: ResourcesConfig,
+	newConfig: ResourcesConfig
+): ResourcesConfig {
+	const resultConfig: Record<string, any> = {};
+
+	for (const category of Object.keys(existingConfig)) {
+		resultConfig[category] = existingConfig[category as keyof ResourcesConfig];
+	}
+
+	for (const key of Object.keys(newConfig).filter(key => key !== 'ssr')) {
+		resultConfig[key] = {
+			...resultConfig[key],
+			...newConfig[key as Exclude<keyof ResourcesConfig, 'ssr'>],
+		};
+	}
+
+	resultConfig.ssr = newConfig.ssr;
+
+	return resultConfig;
+}
+
+function mergeLibraryOptions(
+	existingConfig: LibraryOptions,
+	newConfig: LibraryOptions
+): LibraryOptions {
+	const resultConfig: Record<string, any> = {};
+
+	for (const category of Object.keys(existingConfig)) {
+		resultConfig[category] = existingConfig[category as keyof LibraryOptions];
+	}
+
+	for (const category of Object.keys(newConfig)) {
+		resultConfig[category] = {
+			...resultConfig[category],
+			...newConfig[category as keyof LibraryOptions],
+		};
+	}
+
+	return resultConfig;
+}

package/src/singleton/Analytics/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 AnalyticsConfig = PinpointProviderConfig;

package/src/singleton/Auth/index.ts

@@ -11,7 +11,7 @@ import {
 	LibraryAuthOptions,
 } from './types';
 import { asserts } from '../../Util/errors/AssertError';
-import { AUTH_CONFING_EXCEPTION } from '../../constants';
+import { AUTH_CONFING_EXCEPTION } from '../../Util/Constants';
 
 export function isTokenExpired({
 	expiresAt,
@@ -57,15 +57,17 @@ export class AuthClass {
 		let tokens: AuthTokens | undefined;
 		let credentialsAndIdentityId: AWSCredentialsAndIdentityId | undefined;
 
-		// 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;
 		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;
+
 		if (tokens) {
 			// getCredentialsAndIdentityId will throw if cannot get credentials (network or service error)
 			credentialsAndIdentityId =
@@ -77,7 +79,7 @@ export class AuthClass {
 						forceRefresh: options.forceRefresh,
 					}
 				);
-		} else {
+		} else if (!this.authConfig.isMandatorySignInEnabled) {
 			// getCredentialsAndIdentityId will throw if cannot get credentials (network or service error)
 			credentialsAndIdentityId =
 				await this.authOptions?.credentialsProvider?.getCredentialsAndIdentityId(

package/src/singleton/Auth/types.ts

@@ -3,8 +3,6 @@
 // From https://github.com/awslabs/aws-jwt-verify/blob/main/src/safe-json-parse.ts
 // From https://github.com/awslabs/aws-jwt-verify/blob/main/src/jwt-model.ts
 
-import { Credentials } from '@aws-sdk/types';
-
 interface JwtPayloadStandardFields {
 	exp?: number; // expires: https://tools.ietf.org/html/rfc7519#section-4.1.4
 	iss?: string; // issuer: https://tools.ietf.org/html/rfc7519#section-4.1.1
@@ -56,7 +54,7 @@ export interface AWSCredentialsAndIdentityIdProvider {
 export type TokenProvider = {
 	getTokens: ({
 		forceRefresh,
-	}: {
+	}?: {
 		forceRefresh?: boolean;
 	}) => Promise<AuthTokens | null>;
 };
@@ -70,10 +68,19 @@ export type AuthTokens = {
 	accessToken: JWT;
 };
 
-export type AuthConfig =
+export type AuthConfig = StrictUnion<
 	| IdentityPoolConfig
 	| UserPoolConfig
-	| UserPoolConfigAndIdentityPoolConfig;
+	| UserPoolConfigWithOAuth
+	| UserPoolConfigAndIdentityPoolConfig
+	| UserPoolConfigAndIdentityPoolConfigWithOAuth
+>;
+
+type UnionKeys<T> = T extends T ? keyof T : never;
+type StrictUnionHelper<T, TAll> = T extends any
+	? T & Partial<Record<Exclude<UnionKeys<TAll>, keyof T>, never>>
+	: never;
+type StrictUnion<T> = StrictUnionHelper<T, T>;
 
 export type IdentityPoolConfig = {
 	identityPoolId: string;
@@ -90,6 +97,22 @@ export type UserPoolConfig = {
 	clientMetadata?: Record<string, string>;
 };
 
+export type UserPoolConfigWithOAuth = {
+	userPoolWebClientId: string;
+	userPoolId: string;
+	identityPoolId?: never;
+	clientMetadata?: Record<string, string>;
+	oauth: OAuthConfig;
+};
+
+export type OAuthConfig = {
+	domain: string;
+	scopes: Array<string>;
+	redirectSignIn: string;
+	redirectSignOut: string;
+	responseType: string;
+};
+
 export type UserPoolConfigAndIdentityPoolConfig = {
 	userPoolWebClientId: string;
 	userPoolId: string;
@@ -98,6 +121,15 @@ export type UserPoolConfigAndIdentityPoolConfig = {
 	isMandatorySignInEnabled?: boolean;
 };
 
+export type UserPoolConfigAndIdentityPoolConfigWithOAuth = {
+	userPoolWebClientId: string;
+	userPoolId: string;
+	identityPoolId: string;
+	clientMetadata?: Record<string, string>;
+	isMandatorySignInEnabled?: boolean;
+	oauth: OAuthConfig;
+};
+
 export type GetCredentialsOptions =
 	| GetCredentialsAuthenticatedUser
 	| GetCredentialsUnauthenticatedUser;
@@ -106,7 +138,7 @@ type GetCredentialsAuthenticatedUser = {
 	authenticated: true;
 	forceRefresh?: boolean;
 	authConfig: AuthConfig;
-	tokens?: AuthTokens;
+	tokens: AuthTokens;
 };
 
 type GetCredentialsUnauthenticatedUser = {

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

@@ -8,11 +8,17 @@ import {
 	JWT,
 	UserPoolConfig,
 	UserPoolConfigAndIdentityPoolConfig,
+	UserPoolConfigAndIdentityPoolConfigWithOAuth,
+	UserPoolConfigWithOAuth,
 } from '../types';
 
 export function assertTokenProviderConfig(
 	authConfig?: AuthConfig
-): asserts authConfig is UserPoolConfig {
+): asserts authConfig is
+	| UserPoolConfigAndIdentityPoolConfigWithOAuth
+	| UserPoolConfigWithOAuth
+	| UserPoolConfigAndIdentityPoolConfig
+	| UserPoolConfig {
 	const validConfig =
 		!!authConfig?.userPoolId && !!authConfig?.userPoolWebClientId;
 	return asserts(validConfig, {
@@ -22,6 +28,26 @@ export function assertTokenProviderConfig(
 	});
 }
 
+export function assertOAuthConfig(
+	authConfig?: AuthConfig
+): asserts authConfig is
+	| UserPoolConfigAndIdentityPoolConfigWithOAuth
+	| UserPoolConfigWithOAuth {
+	assertTokenProviderConfig(authConfig);
+	const validOAuthConfig =
+		!!authConfig.oauth?.domain &&
+		!!authConfig.oauth?.redirectSignOut &&
+		!!authConfig.oauth?.redirectSignIn &&
+		!!authConfig.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',
+	});
+}
+
 export function assertIdentityPooIdConfig(
 	authConfig: AuthConfig
 ): asserts authConfig is IdentityPoolConfig {

package/src/singleton/Storage/types.ts

@@ -6,6 +6,7 @@ export type StorageAccessLevel = 'guest' | 'protected' | 'private';
 export interface StorageConfig {
 	bucket?: string;
 	region?: string;
+	dangerouslyConnectToHttpEndpointForTesting?: string;
 }
 
 type StoragePrefixResolver = (params: {
@@ -13,9 +14,11 @@ type StoragePrefixResolver = (params: {
 	targetIdentityId?: string;
 }) => Promise<string>;
 
-// TODO[AllanZhengYP]: support isObjectLockEnabled config to S3 plugin config
 // TODO[AllanZhengYP]: need to finalize the decision whether to move defaultAccessLevel to StorageConfig
 export interface LibraryStorageOptions {
-	prefixResolver?: StoragePrefixResolver;
-	defaultAccessLevel?: StorageAccessLevel;
+	AWSS3: {
+		prefixResolver?: StoragePrefixResolver;
+		defaultAccessLevel?: StorageAccessLevel;
+		isObjectLockEnabled?: boolean;
+	};
 }

package/src/singleton/apis/fetchAuthSession.ts

@@ -0,0 +1,12 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { fetchAuthSession as fetchAuthSessionInternal } from './internal/fetchAuthSession';
+import { Amplify } from '../Amplify';
+import { AuthSession, FetchAuthSessionOptions } from '../Auth/types';
+
+export const fetchAuthSession = (
+	options?: FetchAuthSessionOptions
+): Promise<AuthSession> => {
+	return fetchAuthSessionInternal(Amplify, options);
+};

package/src/singleton/apis/internal/fetchAuthSession.ts

@@ -0,0 +1,12 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { AmplifyClass } from '../../Amplify';
+import { AuthSession, FetchAuthSessionOptions } from '../../Auth/types';
+
+export const fetchAuthSession = (
+	amplify: AmplifyClass,
+	options?: FetchAuthSessionOptions
+): Promise<AuthSession> => {
+	return amplify.Auth.fetchAuthSession(options);
+};

package/src/singleton/apis/server/fetchAuthSession.ts

@@ -0,0 +1,16 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { AmplifyServer, getAmplifyServerContext } from '../../../adapterCore';
+import { AuthSession, FetchAuthSessionOptions } from '../../Auth/types';
+import { fetchAuthSession as fetchAuthSessionInternal } from '../internal/fetchAuthSession';
+
+export const fetchAuthSession = (
+	contextSpec: AmplifyServer.ContextSpec,
+	options?: FetchAuthSessionOptions
+): Promise<AuthSession> => {
+	return fetchAuthSessionInternal(
+		getAmplifyServerContext(contextSpec).amplify,
+		options
+	);
+};

package/src/singleton/index.ts

@@ -1,131 +1,5 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { AuthClass } from './Auth';
-import { Hub } from '../Hub';
-import { LibraryOptions, ResourcesConfig } from './types';
-import { AmplifyError } from '../Errors';
-import { FetchAuthSessionOptions } from './Auth/types';
 
-// TODO(v6): add default AuthTokenStore for each platform
-
-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 = {};
-	}
-
-	/**
-	 * Configures Amplify for use with your back-end resources.
-	 *
-	 * @remarks
-	 * `configure` can be used to specify additional library options where available for supported categories.
-	 *
-	 * @param resourceConfig - Back-end resource configuration. Typically provided via the `aws-exports.js` file.
-	 * @param libraryOptions - Additional options for customizing the behavior of the library.
-	 */
-	configure(
-		resourcesConfig: ResourcesConfig,
-		libraryOptions: LibraryOptions = {}
-	): void {
-		this.resourcesConfig = mergeResourceConfig(
-			this.resourcesConfig,
-			resourcesConfig
-		);
-
-		this.libraryOptions = mergeLibraryOptions(
-			this.libraryOptions,
-			libraryOptions
-		);
-
-		this.Auth.configure(this.resourcesConfig.Auth!, this.libraryOptions.Auth);
-
-		Hub.dispatch(
-			'core',
-			{
-				event: 'configure',
-				data: resourcesConfig,
-			},
-			'Configure'
-		);
-	}
-
-	/**
-	 * Provides access to the current back-end resource configuration for the Library.
-	 *
-	 * @returns Returns the current back-end resource configuration.
-	 */
-	getConfig(): ResourcesConfig {
-		return JSON.parse(JSON.stringify(this.resourcesConfig));
-	}
-}
-
-/**
- * The `Amplify` utility is used to configure the library.
- *
- * @remarks
- * `Amplify` is responsible for orchestrating cross-category communication within the library.
- */
-export const AmplifyV6 = new AmplifyClass();
-
-/**
- * Returns current session tokens and credentials
- *
- * @param options{FetchAuthSessionOptions} - Options for fetching session.
- *
- * @returns Returns a promise that will resolve with fresh authentication tokens.
- */
-export const fetchAuthSession = (options: FetchAuthSessionOptions) => {
-	return AmplifyV6.Auth.fetchAuthSession(options);
-};
-
-// TODO(v6): validate until which level this will nested, during Amplify.configure API review.
-function mergeResourceConfig(
-	existingConfig: ResourcesConfig,
-	newConfig: ResourcesConfig
-): ResourcesConfig {
-	const resultConfig: Record<string, any> = {};
-
-	for (const category of Object.keys(existingConfig)) {
-		resultConfig[category] = existingConfig[category as keyof ResourcesConfig];
-	}
-
-	for (const category of Object.keys(newConfig)) {
-		resultConfig[category] = {
-			...resultConfig[category],
-			...newConfig[category as keyof ResourcesConfig],
-		};
-	}
-
-	return resultConfig;
-}
-
-function mergeLibraryOptions(
-	existingConfig: LibraryOptions,
-	newConfig: LibraryOptions
-): LibraryOptions {
-	const resultConfig: Record<string, any> = {};
-
-	for (const category of Object.keys(existingConfig)) {
-		resultConfig[category] = existingConfig[category as keyof LibraryOptions];
-	}
-
-	for (const category of Object.keys(newConfig)) {
-		resultConfig[category] = {
-			...resultConfig[category],
-			...newConfig[category as keyof LibraryOptions],
-		};
-	}
-
-	return resultConfig;
-}
+export { AmplifyClass, Amplify } from './Amplify';
+export { fetchAuthSession } from './apis/fetchAuthSession';

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 { AnalyticsConfig } from './Analytics/types';
 import {
 	AuthConfig,
 	LibraryAuthOptions,
@@ -14,14 +15,12 @@ import {
 	StorageAccessLevel,
 	StorageConfig,
 } from './Storage/types';
-import {
-	CacheConfig
-} from '../Cache/types';
+import { CacheConfig } from '../Cache/types';
 import { I18nOptions } from '../I18n/types';
 
 export type ResourcesConfig = {
 	API?: {};
-	Analytics?: {};
+	Analytics?: AnalyticsConfig;
 	Auth?: AuthConfig;
 	Cache?: CacheConfig;
 	DataStore?: {};
@@ -30,6 +29,7 @@ export type ResourcesConfig = {
 	Notifications?: {};
 	Predictions?: {};
 	Storage?: StorageConfig;
+	ssr?: boolean;
 };
 
 export type LibraryOptions = {

package/src/types/core.ts

@@ -0,0 +1,58 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export interface AmplifyConfig {
+	Analytics?: object;
+	Auth?: object;
+	API?: object;
+	Logging?: object;
+	Storage?: object;
+	Cache?: object;
+	Geo?: object;
+	Notifications?: {
+		InAppMessaging?: object;
+	};
+	ssr?: boolean;
+}
+
+export type UserProfile = {
+	attributes?: Record<string, string[]>;
+	demographic?: {
+		appVersion?: string;
+		locale?: string;
+		make?: string;
+		model?: string;
+		modelVersion?: string;
+		platform?: string;
+		platformVersion?: string;
+		timezone?: string;
+	};
+	location?: {
+		city?: string;
+		country?: string;
+		latitude?: number;
+		longitude?: number;
+		postalCode?: string;
+		region?: string;
+	};
+	metrics?: Record<string, number>;
+};
+
+export interface ICredentials {
+	accessKeyId: string;
+	sessionToken: string;
+	secretAccessKey: string;
+	identityId: string;
+	authenticated: boolean;
+	// Long term creds do not provide an expiration date
+	expiration?: Date;
+}
+
+/**
+ * @internal
+ */
+export type DelayFunction = (
+	attempt: number,
+	args?: any[],
+	error?: unknown
+) => number | false;

package/src/types/errors.ts

@@ -0,0 +1,21 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export type ErrorParams = {
+	message: string;
+	name: string;
+	recoverySuggestion?: string;
+	underlyingError?: Error | unknown;
+};
+
+export type AmplifyErrorMap<ErrorCode extends string> = {
+	[name in ErrorCode]: {
+		message: string;
+		recoverySuggestion?: string;
+	};
+};
+
+export type ServiceError = {
+	name: string;
+	message: string;
+};