fix(amplifyConfig): Amplify.configure.category should not allow empty…

… object (#12540) * chore(interactions analytics): move common type to parent * chore(storage): add AtLeastOne type * fix(api): Amplify.Configure.API should have atleast one key * fix(geo): Amplify.Configure.Geo should have atleast one key * fix(predictions): Amplify.Configure.Predictions should have atleast one key * fix(notifications): Amplify.Configure.Notifications should have atleast one key --------- Co-authored-by: Ashwin Kumar <[email protected]>
aws-amplify · Nov 10, 2023 · 17ffbdd · 17ffbdd
1 parent b778a9e
commit 17ffbdd
Show file tree

Hide file tree

Showing 10 changed files with 69 additions and 32 deletions.
diff --git a/packages/core/src/parseAWSExports.ts b/packages/core/src/parseAWSExports.ts
@@ -77,22 +77,25 @@ 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,
+			amplifyConfig.Notifications = {
+				InAppMessaging: {
+					Pinpoint: {
+						appId,
+						region,
+					},
 				},
 			};
 		}
 		if (Push?.AWSPinpoint) {
 			const { appId, region } = Push.AWSPinpoint;
-			amplifyConfig.Notifications.PushNotification = {
-				Pinpoint: {
-					appId,
-					region,
+			amplifyConfig.Notifications = {
+				PushNotification: {
+					Pinpoint: {
+						appId,
+						region,
+					},
 				},
 			};
 		}

diff --git a/packages/core/src/singleton/API/types.ts b/packages/core/src/singleton/API/types.ts
@@ -1,6 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import { Headers } from '../../clients';
+import { AtLeastOne } from '../types';
 
 export type LibraryAPIOptions = {
 	GraphQL?: {
@@ -66,11 +67,16 @@ type APIRestConfig = {
 	service?: string;
 };
 
-export type APIConfig = {
-	REST?: Record<string, APIRestConfig>;
-	GraphQL?: APIGraphQLConfig;
+export type RESTProviderConfig = {
+	REST: Record<string, APIRestConfig>;
 };
 
+export type GraphQLProviderConfig = {
+	GraphQL: APIGraphQLConfig;
+};
+
+export type APIConfig = AtLeastOne<RESTProviderConfig & GraphQLProviderConfig>;
+
 export type GraphQLAuthMode =
 	| 'apiKey'
 	| 'oidc'

diff --git a/packages/core/src/singleton/Analytics/types.ts b/packages/core/src/singleton/Analytics/types.ts
@@ -5,9 +5,7 @@ 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';
-
-type AtLeastOne<T, U = { [K in keyof T]: Pick<T, K> }> = Partial<T> &
-	U[keyof U];
+import { AtLeastOne } from '../types';
 
 export type AnalyticsConfig = AtLeastOne<
 	PinpointProviderConfig &

diff --git a/packages/core/src/singleton/Geo/types.ts b/packages/core/src/singleton/Geo/types.ts
@@ -1,8 +1,10 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-export interface GeoConfig {
-	LocationService?: {
+import { AtLeastOne } from '../types';
+
+export type LocationServiceConfig = {
+	LocationService: {
 		region: string;
 		maps?: {
 			items: {};
@@ -17,4 +19,6 @@ export interface GeoConfig {
 			default: string;
 		};
 	};
-}
+};
+
+export type GeoConfig = AtLeastOne<LocationServiceConfig>;
diff --git a/packages/core/src/singleton/Interactions/types.ts b/packages/core/src/singleton/Interactions/types.ts
@@ -1,6 +1,8 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+import { AtLeastOne } from '../types';
+
 interface LexV1BotConfig {
 	alias: string;
 	region: string;
@@ -21,9 +23,6 @@ type InteractionsLexV2Config = {
 	LexV2: Record<string, LexV2BotConfig>;
 };
 
-type AtLeastOne<T, U = { [K in keyof T]: Pick<T, K> }> = Partial<T> &
-	U[keyof U];
-
 export type InteractionsConfig = AtLeastOne<
 	InteractionsLexV1Config & InteractionsLexV2Config
 >;
diff --git a/packages/core/src/singleton/Notifications/types.ts b/packages/core/src/singleton/Notifications/types.ts
@@ -3,8 +3,16 @@
 
 import { InAppMessagingConfig } from './InAppMessaging/types';
 import { PushNotificationConfig } from './PushNotification/types';
+import { AtLeastOne } from '../types';
 
-export type NotificationsConfig = {
-	InAppMessaging?: InAppMessagingConfig;
-	PushNotification?: PushNotificationConfig;
+export type InAppMessagingProviderConfig = {
+	InAppMessaging: InAppMessagingConfig;
 };
+
+export type PushNotificationProviderConfig = {
+	PushNotification: PushNotificationConfig;
+};
+
+export type NotificationsConfig = AtLeastOne<
+	InAppMessagingProviderConfig & PushNotificationProviderConfig
+>;
diff --git a/packages/core/src/singleton/Predictions/types.ts b/packages/core/src/singleton/Predictions/types.ts
@@ -1,6 +1,8 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+import { AtLeastOne } from '../types';
+
 // Defaults for ConvertConfig
 type SpeechGeneratorDefaults = {
 	voiceId?: string;
@@ -54,8 +56,18 @@ export type PredictionsProviderConfig<T> = {
 	defaults?: T;
 };
 
-export type PredictionsConfig = {
-	convert?: ConvertConfig;
-	identify?: IdentifyConfig;
-	interpret?: InterpretConfig;
+export type PredictionsConvertConfig = {
+	convert: ConvertConfig;
+};
+export type PredictionsIdentifyConfig = {
+	identify: IdentifyConfig;
 };
+export type PredictionsInterpretConfig = {
+	interpret: InterpretConfig;
+};
+
+export type PredictionsConfig = AtLeastOne<
+	PredictionsConvertConfig &
+		PredictionsIdentifyConfig &
+		PredictionsInterpretConfig
+>;
diff --git a/packages/core/src/singleton/Storage/types.ts b/packages/core/src/singleton/Storage/types.ts
@@ -1,9 +1,11 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+import { AtLeastOne } from '../types';
+
 export type StorageAccessLevel = 'guest' | 'protected' | 'private';
 
-export interface StorageConfig {
+export type S3ProviderConfig = {
 	S3: {
 		bucket?: string;
 		region?: string;
@@ -14,7 +16,9 @@ export interface StorageConfig {
 		 */
 		dangerouslyConnectToHttpEndpointForTesting?: string;
 	};
-}
+};
+
+export type StorageConfig = AtLeastOne<S3ProviderConfig>;
 
 type StoragePrefixResolver = (params: {
 	accessLevel: StorageAccessLevel;

diff --git a/packages/core/src/singleton/types.ts b/packages/core/src/singleton/types.ts
@@ -29,6 +29,9 @@ export type LegacyConfig = {
 	aws_project_region?: string;
 };
 
+export type AtLeastOne<T, U = { [K in keyof T]: Pick<T, K> }> = Partial<T> &
+	U[keyof U];
+
 export type ResourcesConfig = {
 	API?: APIConfig;
 	Analytics?: AnalyticsConfig;

diff --git a/packages/geo/src/Geo.ts b/packages/geo/src/Geo.ts
@@ -32,11 +32,11 @@ export class GeoClass {
 	/**
 	 * @private
 	 */
-	private _config: GeoConfig;
+	private _config?: GeoConfig;
 	private _pluggables: GeoProvider[];
 
 	constructor() {
-		this._config = {};
+		this._config = undefined;
 		this._pluggables = [];
 
 		const amplifyConfig = Amplify.getConfig() ?? {};