@aws-amplify/core 6.0.1-console-preview.096eee3.0 → 6.0.1-console-preview.3b09ef9.0

package/src/singleton/Auth/types.ts

@@ -71,66 +71,79 @@ export type AuthTokens = {
 };
 
 export type AuthConfig = StrictUnion<
-	| IdentityPoolConfig
-	| UserPoolConfig
-	| UserPoolConfigWithOAuth
-	| UserPoolConfigAndIdentityPoolConfig
-	| UserPoolConfigAndIdentityPoolConfigWithOAuth
+	| AuthIdentityPoolConfig
+	| AuthUserPoolConfig
+	| AuthUserPoolAndIdentityPoolConfig
 >;
 
 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 StrictUnion<T> = StrictUnionHelper<T, T>;
 
-export type IdentityPoolConfig = {
+export type AuthIdentityPoolConfig = {
+	Cognito: CognitoIdentityPoolConfig & {
+		userPoolClientId?: never;
+		userPoolId?: never;
+		loginWith?: never;
+	};
+};
+
+export type CognitoIdentityPoolConfig = {
 	identityPoolId: string;
-	userPoolWebClientId?: never;
-	userPoolId?: never;
-	clientMetadata?: never;
-	isMandatorySignInEnabled?: never;
+	allowGuestAccess?: boolean;
 };
 
-export type UserPoolConfig = {
-	userPoolWebClientId: string;
-	userPoolId: string;
-	identityPoolId?: never;
-	clientMetadata?: Record<string, string>;
+export type AuthUserPoolConfig = {
+	Cognito: CognitoUserPoolConfig & {
+		identityPoolId?: never;
+		allowGuestAccess?: never;
+	};
 };
 
-export type UserPoolConfigWithOAuth = {
-	userPoolWebClientId: string;
+export type CognitoUserPoolConfig = {
+	userPoolClientId: string;
 	userPoolId: string;
-	identityPoolId?: never;
-	clientMetadata?: Record<string, string>;
-	oauth: OAuthConfig;
+	signUpVerificationMethod?: 'code' | 'link';
+	loginWith?: {
+		oauth?: OAuthConfig;
+	};
 };
 
 export type OAuthConfig = {
 	domain: string;
-	scopes: Array<string>;
-	redirectSignIn: string;
-	redirectSignOut: string;
-	responseType: string;
+	scopes: Array<OAuthScope>;
+	redirectSignIn: Array<string>;
+	redirectSignOut: Array<string>;
+	responseType: 'code' | 'token';
+	providers?: Array<OAuthProviders | CustomProvider>;
 };
 
-export type UserPoolConfigAndIdentityPoolConfig = {
-	userPoolWebClientId: string;
-	userPoolId: string;
-	identityPoolId: string;
-	clientMetadata?: Record<string, string>;
-	isMandatorySignInEnabled?: boolean;
-};
+type OAuthProviders = 'Google' | 'Facebook' | 'Amazon' | 'Apple';
+type CustomProvider = { custom: string };
 
-export type UserPoolConfigAndIdentityPoolConfigWithOAuth = {
-	userPoolWebClientId: string;
-	userPoolId: string;
-	identityPoolId: string;
-	clientMetadata?: Record<string, string>;
-	isMandatorySignInEnabled?: boolean;
-	oauth: OAuthConfig;
+type CustomScope = string & {};
+type OAuthScope =
+	| 'email'
+	| 'openid'
+	| 'phone'
+	| 'email'
+	| 'profile'
+	| 'aws.cognito.signin.user.admin'
+	| CustomScope;
+
+export type CognitoUserPoolWithOAuthConfig = CognitoUserPoolConfig & {
+	loginWith: {
+		oauth: OAuthConfig;
+	};
 };
+export type AuthUserPoolAndIdentityPoolConfig = {
+	Cognito: CognitoUserPoolAndIdentityPoolConfig;
+};
+
+export type CognitoUserPoolAndIdentityPoolConfig = CognitoUserPoolConfig &
+	CognitoIdentityPoolConfig;
 
 export type GetCredentialsOptions =
 	| GetCredentialsAuthenticatedUser

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

@@ -1,26 +1,36 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import { asserts } from '../../../Util/errors/AssertError';
+
 import {
 	AuthConfig,
-	IdentityPoolConfig,
 	JWT,
-	UserPoolConfig,
-	UserPoolConfigAndIdentityPoolConfig,
-	UserPoolConfigAndIdentityPoolConfigWithOAuth,
-	UserPoolConfigWithOAuth,
+	AuthUserPoolAndIdentityPoolConfig,
+	CognitoUserPoolWithOAuthConfig,
+	CognitoUserPoolConfig,
+	CognitoUserPoolAndIdentityPoolConfig,
+	CognitoIdentityPoolConfig,
+	StrictUnion,
 } from '../types';
 
 export function assertTokenProviderConfig(
-	authConfig?: AuthConfig
-): asserts authConfig is
-	| UserPoolConfigAndIdentityPoolConfigWithOAuth
-	| UserPoolConfigWithOAuth
-	| UserPoolConfigAndIdentityPoolConfig
-	| UserPoolConfig {
-	const validConfig =
-		!!authConfig?.userPoolId && !!authConfig?.userPoolWebClientId;
-	return asserts(validConfig, {
+	cognitoConfig?: StrictUnion<
+		| CognitoUserPoolConfig
+		| CognitoUserPoolAndIdentityPoolConfig
+		| CognitoIdentityPoolConfig
+	>
+): asserts cognitoConfig is
+	| CognitoUserPoolAndIdentityPoolConfig
+	| CognitoUserPoolConfig {
+	let assertionValid = true; // assume valid until otherwise proveed
+	if (!cognitoConfig) {
+		assertionValid = false;
+	} else {
+		assertionValid =
+			!!cognitoConfig.userPoolClientId && !!cognitoConfig.userPoolClientId;
+	}
+
+	return asserts(assertionValid, {
 		name: 'AuthTokenConfigException',
 		message: 'Auth Token Provider not configured',
 		recoverySuggestion: 'Make sure to call Amplify.configure in your app',
@@ -28,16 +38,13 @@ export function assertTokenProviderConfig(
 }
 
 export function assertOAuthConfig(
-	authConfig?: AuthConfig
-): asserts authConfig is
-	| UserPoolConfigAndIdentityPoolConfigWithOAuth
-	| UserPoolConfigWithOAuth {
-	assertTokenProviderConfig(authConfig);
+	cognitoConfig?: CognitoUserPoolConfig | CognitoUserPoolAndIdentityPoolConfig
+): asserts cognitoConfig is CognitoUserPoolWithOAuthConfig {
 	const validOAuthConfig =
-		!!authConfig.oauth?.domain &&
-		!!authConfig.oauth?.redirectSignOut &&
-		!!authConfig.oauth?.redirectSignIn &&
-		!!authConfig.oauth?.responseType;
+		!!cognitoConfig?.loginWith?.oauth?.domain &&
+		!!cognitoConfig?.loginWith?.oauth?.redirectSignOut &&
+		!!cognitoConfig?.loginWith?.oauth?.redirectSignIn &&
+		!!cognitoConfig?.loginWith?.oauth?.responseType;
 
 	return asserts(validOAuthConfig, {
 		name: 'OAuthNotConfigureException',
@@ -48,9 +55,13 @@ export function assertOAuthConfig(
 }
 
 export function assertIdentityPooIdConfig(
-	authConfig: AuthConfig
-): asserts authConfig is IdentityPoolConfig {
-	const validConfig = !!authConfig?.identityPoolId;
+	cognitoConfig?: StrictUnion<
+		| CognitoUserPoolConfig
+		| CognitoUserPoolAndIdentityPoolConfig
+		| CognitoIdentityPoolConfig
+	>
+): asserts cognitoConfig is CognitoIdentityPoolConfig {
+	const validConfig = !!cognitoConfig?.identityPoolId;
 	return asserts(validConfig, {
 		name: 'AuthIdentityPoolIdException',
 		message: 'Auth IdentityPoolId not configured',
@@ -59,10 +70,11 @@ export function assertIdentityPooIdConfig(
 	});
 }
 
-export function assertUserPoolAndIdentityPooConfig(
+function assertUserPoolAndIdentityPooConfig(
 	authConfig: AuthConfig
-): asserts authConfig is UserPoolConfigAndIdentityPoolConfig {
-	const validConfig = !!authConfig?.identityPoolId && !!authConfig?.userPoolId;
+): asserts authConfig is AuthUserPoolAndIdentityPoolConfig {
+	const validConfig =
+		!!authConfig?.Cognito.identityPoolId && !!authConfig?.Cognito.userPoolId;
 	return asserts(validConfig, {
 		name: 'AuthUserPoolAndIdentityPoolException',
 		message: 'Auth UserPool and IdentityPool not configured',

package/src/singleton/Storage/types.ts

@@ -4,9 +4,11 @@
 export type StorageAccessLevel = 'guest' | 'protected' | 'private';
 
 export interface StorageConfig {
-	bucket?: string;
-	region?: string;
-	dangerouslyConnectToHttpEndpointForTesting?: string;
+	S3: {
+		bucket?: string;
+		region?: string;
+		dangerouslyConnectToHttpEndpointForTesting?: string;
+	}
 }
 
 type StoragePrefixResolver = (params: {
@@ -16,7 +18,7 @@ type StoragePrefixResolver = (params: {
 
 // TODO[AllanZhengYP]: need to finalize the decision whether to move defaultAccessLevel to StorageConfig
 export interface LibraryStorageOptions {
-	AWSS3: {
+	S3: {
 		prefixResolver?: StoragePrefixResolver;
 		defaultAccessLevel?: StorageAccessLevel;
 		isObjectLockEnabled?: boolean;

package/src/singleton/types.ts

@@ -5,9 +5,9 @@ import { AnalyticsConfig } from './Analytics/types';
 import {
 	AuthConfig,
 	LibraryAuthOptions,
-	UserPoolConfig,
-	IdentityPoolConfig,
-	UserPoolConfigAndIdentityPoolConfig,
+	AuthUserPoolConfig,
+	AuthIdentityPoolConfig,
+	AuthUserPoolAndIdentityPoolConfig,
 	GetCredentialsOptions,
 } from './Auth/types';
 import {
@@ -15,19 +15,18 @@ import {
 	StorageAccessLevel,
 	StorageConfig,
 } from './Storage/types';
-import { CacheConfig } from '../Cache/types';
 import { I18nOptions } from '../I18n/types';
 
 export type ResourcesConfig = {
-	API?: {};
+	// API?: {};
 	Analytics?: AnalyticsConfig;
 	Auth?: AuthConfig;
-	Cache?: CacheConfig;
-	DataStore?: {};
-	I18n?: I18nOptions;
-	Interactions?: {};
-	Notifications?: {};
-	Predictions?: {};
+	// Cache?: CacheConfig;
+	// DataStore?: {};
+	// I18n?: I18nOptions;
+	// Interactions?: {};
+	// Notifications?: {};
+	// Predictions?: {};
 	Storage?: StorageConfig;
 	ssr?: boolean;
 };
@@ -39,10 +38,11 @@ export type LibraryOptions = {
 
 export {
 	AuthConfig,
-	UserPoolConfig,
-	IdentityPoolConfig,
-	UserPoolConfigAndIdentityPoolConfig,
+	AuthUserPoolConfig as UserPoolConfig,
+	AuthIdentityPoolConfig as IdentityPoolConfig,
+	AuthUserPoolAndIdentityPoolConfig as UserPoolConfigAndIdentityPoolConfig,
 	GetCredentialsOptions,
 	StorageAccessLevel,
 	StorageConfig,
+	AnalyticsConfig,
 };