feat(core): add AmplifyOutputs types based on the Amplify Gen 2 client config schema #4859

NikaHsn · 2024-05-08T19:50:54Z

Issue #, if available:

Description of changes:

add AmplifyOutputs types representing the Amplify Gen 2 client config schema
updated CognitoUserAttributeKeyConverter to not convert keys to upper case and add a new CognitoUserAttributeKeyConverterToUpperCase for converting keys to upper case (this is only used by AmplifConfig as the user attribute keys are upper case in the amplifyconfiguration file)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Jordan-Nelson · 2024-05-10T18:03:48Z

packages/amplify_core/lib/src/config/amplify_outputs/amplify_outputs.dart

+part 'amplify_outputs.g.dart';
+
+/// {@template amplify_core.amplify_outputs}
+/// The amplify outputs generated by Amplify CLI Gen2 for


nit: I think "CLI" isn't being used when referring to gen 2. "Gen 2" should have a space.

Suggested change

/// The amplify outputs generated by Amplify CLI Gen2 for

/// The amplify outputs generated by Amplify Gen 2 for

Jordan-Nelson · 2024-05-10T19:28:13Z

packages/amplify_core/lib/src/config/amplify_outputs/amplify_outputs.dart

+  /// {@macro amplify_core.amplify_outputs.storage_outputs}
+  final StorageOutputs? storage;
+
+  /// The custom outputs generated by CLI Gen2.


Suggested change

/// The custom outputs generated by CLI Gen2.

/// The custom outputs generated by Amplify Gen 2.

packages/amplify_core/lib/src/config/amplify_outputs/amplify_outputs.dart

packages/amplify_core/lib/src/config/amplify_outputs/notifications/notifications_outputs.dart

Jordan-Nelson · 2024-05-10T20:02:24Z

packages/amplify_core/lib/src/config/amplify_outputs/analytics/amazon_pinpoint.dart

+/// The Amazon Pinpoint outputs used by Analytics category plugin
+/// to communicate with backend services.


nit/suggestion: Trim these a bit and remove the mention of what category it is for. The customer will know what category it is used for since it is nested under the category.

Q: This class is only used for Analytics, but couldn't it potentially be re-used for Push Notification, or some other category that uses pinpoint?

Suggested change

/// The Amazon Pinpoint outputs used by Analytics category plugin

/// to communicate with backend services.

/// The Amplify Gen 2 output for Amazon Pinpoint.

Jordan-Nelson · 2024-05-10T20:25:19Z

packages/amplify_core/lib/src/config/amplify_outputs/auth/auth_outputs.dart

+    this.standardRequiredAttributes,
+    this.usernameAttributes,
+    this.userVerificationTypes,
+    this.unauthenticatedIdentitiesEnabled = true,


Q: It looks like this is new. Gen 1 config does not have this AFAIK. Are we supposed to make any changes in amplify auth to consume this? For example, should amplify auth throw when fetchAuthSession is called for an unauthenticated user if this is false? Is there a task tracking that?

Correct, the Gen 1 config does not have this field. Guest access is allowed if it's enabled on the backend. Libraries initiate the request, and upon success, they get guest credentials otherwise an error is returned. Android and iOS also ignore this value from Gen 2 config meaning no changes are needed within Amplify Auth to use this value.

packages/amplify_core/lib/src/config/amplify_outputs/auth/mfa.dart

Jordan-Nelson · 2024-05-10T20:35:18Z

packages/amplify_core/lib/src/config/amplify_outputs/auth/mfa.dart

+/// The MFA method of Amazon Cognito User Pool for
+/// sending the authorization code.


nit: TOTP codes are not "sent" so I would remove that portion.

Suggested change

/// The MFA method of Amazon Cognito User Pool for

/// sending the authorization code.

/// The MFA method of Amazon Cognito User Pool.

Jordan-Nelson · 2024-05-10T20:55:36Z

packages/amplify_core/lib/src/config/amplify_outputs/auth/password_policy.dart

+  final bool? requireNumbers;
+
+  /// Requires lower case.
+  final bool? requireLowercase;
+
+  /// Requires upper case.
+  final bool? requireUppercase;
+
+  /// Requires symbols.
+  final bool? requireSymbols;


Q: Should all the bool values default to false? The auth/authenticator libraries will have to handle the null case as is. IMO the default values belong here not in the auth/authenticator categories.

Jordan-Nelson · 2024-05-10T20:57:08Z

packages/amplify_core/lib/src/config/amplify_outputs/auth/response_type.dart

+/// {@template amplify_core.amplify_outputs.response_type}
+/// The response type for identity providers set on Amazon Cognito.
+/// {@endtemplate}
+enum ResponseType {


suggestion: OAuthResponseType might be a better name.

…fig schema

…fig schema (#4859)

* feat(core): add AmplifyOutputs types based on the CLI Gen2 client config schema (#4859) * chore: map AmplifyConfig to AmplifyOutputs (#4935) * chore: map AmplifyConfig to AmplifyOutputs * chore: formatting, license headers * chore: rename amplify_outputs_mapping_test.dart * chore: update API config * chore: support multiple graphql or rest APIs (#4982) * chore(core): updated asyncConfig to use AmplifyOutputs * feat(core): add AmplifyOutputs types based on the CLI Gen2 client config schema (#4859) * chore: map AmplifyConfig to AmplifyOutputs (#4935) * chore: map AmplifyConfig to AmplifyOutputs * chore: formatting, license headers * chore: rename amplify_outputs_mapping_test.dart * chore: update API config * chore: support multiple graphql or rest APIs (#4982) * chore(core): updated exports to expose MFA/Password Policies/Identity Providers * chore(auth): updated unit test to use AmplifyOutputs * chore(authenticator): updated to use AmplifyOutputs type * chore(test): updated test stub to use AmplifyOutputs * chore: update gen2 version and config mapping tests (#5010) chore: update gen2 version and tests * chore: supporting missing auth config options (#5011) * chore(core): updated unit tests AmplifyConfig Json to AmplifyOutputs Json * chore(authenticator): updated unit tests AmplifyOutputs Json values * chore(core): updated amplify_core.dart file format * chore(core): re-internalized IdentityProvider, MFA, and PasswordPolicies * chore(authenticator): renamed InheritedConfig.amplifyConfig to InheritedConfig.amplifyOutputs * chore(authenticator): Renamed FormFieldValidator.validateNewPassword's AmplifyOutputs parameter --------- Co-authored-by: NikaHsn <nika.hasani@gmail.com> Co-authored-by: Jordan Nelson <Jordanryannelson@gmail.com>

* feat(core): add AmplifyOutputs types based on the CLI Gen2 client config schema (#4859) * chore: map AmplifyConfig to AmplifyOutputs (#4935) * chore: map AmplifyConfig to AmplifyOutputs * chore: formatting, license headers * chore: rename amplify_outputs_mapping_test.dart * chore: update API config * chore: support multiple graphql or rest APIs (#4982) * chore: update gen2 version and config mapping tests (#5010) chore: update gen2 version and tests * chore: supporting missing auth config options (#5011) * chore: map null passwordSettings to null passwordPolicy (#5024) * chore(core): updated asyncConfig to use AmplifyOutputs (#4995) * feat(core): add AmplifyOutputs types based on the CLI Gen2 client config schema (#4859) * chore: map AmplifyConfig to AmplifyOutputs (#4935) * chore: map AmplifyConfig to AmplifyOutputs * chore: formatting, license headers * chore: rename amplify_outputs_mapping_test.dart * chore: update API config * chore: support multiple graphql or rest APIs (#4982) * chore(core): updated asyncConfig to use AmplifyOutputs * feat(core): add AmplifyOutputs types based on the CLI Gen2 client config schema (#4859) * chore: map AmplifyConfig to AmplifyOutputs (#4935) * chore: map AmplifyConfig to AmplifyOutputs * chore: formatting, license headers * chore: rename amplify_outputs_mapping_test.dart * chore: update API config * chore: support multiple graphql or rest APIs (#4982) * chore(core): updated exports to expose MFA/Password Policies/Identity Providers * chore(auth): updated unit test to use AmplifyOutputs * chore(authenticator): updated to use AmplifyOutputs type * chore(test): updated test stub to use AmplifyOutputs * chore: update gen2 version and config mapping tests (#5010) chore: update gen2 version and tests * chore: supporting missing auth config options (#5011) * chore(core): updated unit tests AmplifyConfig Json to AmplifyOutputs Json * chore(authenticator): updated unit tests AmplifyOutputs Json values * chore(core): updated amplify_core.dart file format * chore(core): re-internalized IdentityProvider, MFA, and PasswordPolicies * chore(authenticator): renamed InheritedConfig.amplifyConfig to InheritedConfig.amplifyOutputs * chore(authenticator): Renamed FormFieldValidator.validateNewPassword's AmplifyOutputs parameter --------- Co-authored-by: NikaHsn <nika.hasani@gmail.com> Co-authored-by: Jordan Nelson <Jordanryannelson@gmail.com> * chore: fix oauth outputs (#5028) * chore: fix oauth outputs * fix naming typo --------- Co-authored-by: Nika Hassani <nikaws@amazon.com> * chore(infra-gen2): Gen 2 infra (#5026) * chore(infra): gen 2 api rename (#5040) * chore(infra): Add verbose flag to deploy step (#5042) * chore: update configure apis to use AmplifyOutputs instead of AmplifyConfig (#5017) * chore(core): add validation checks for AmplifyOutputs Json deserialization (#5077) * Chore/authenticator password validation (#5078) * chore(test): Removed linter ignore * chore(authenticator): cleaned up extra import * chore(authenticator): Updated password policy validator to use a type not affiliated with config * chore(authenticator): updated AmplifyConfig references to AmplifyOutputs --------- Co-authored-by: Jordan Nelson <Jordanryannelson@gmail.com> Co-authored-by: Tyler-Larkin <tyllark@amazon.com> Co-authored-by: Nika Hassani <nikaws@amazon.com> Co-authored-by: Elijah Quartey <Equartey@users.noreply.github.com>

NikaHsn requested a review from a team as a code owner May 8, 2024 19:50

Jordan-Nelson reviewed May 10, 2024

View reviewed changes

NikaHsn force-pushed the feat/config/amplify-outputs branch from 270f8ba to 21a0c89 Compare May 21, 2024 20:33

Nika Hassani added 2 commits May 22, 2024 09:29

feat(core): add AmplifyOutputs types based on the CLI Gen2 client con…

0cfa804

…fig schema

address comments

647cbac

NikaHsn force-pushed the feat/config/amplify-outputs branch from 21a0c89 to 647cbac Compare May 22, 2024 16:29

not export AmplifyOutputs types

34f5c6b

Jordan-Nelson approved these changes May 22, 2024

View reviewed changes

NikaHsn merged commit 8fb9e66 into feat/config-gen2 May 22, 2024
152 of 155 checks passed

NikaHsn changed the title ~~feat(core): add AmplifyOutputs types based on the CLI Gen2 client config schema~~ feat(core): add AmplifyOutputs types based on the Amplify Gen 2 client config schema May 28, 2024

NikaHsn added a commit that referenced this pull request Jun 7, 2024

feat(core): add AmplifyOutputs types based on the CLI Gen2 client con…

4e7f792

…fig schema (#4859)

NikaHsn added a commit that referenced this pull request Jun 13, 2024

feat(core): add AmplifyOutputs types based on the CLI Gen2 client con…

8cc5c7d

…fig schema (#4859)

NikaHsn deleted the feat/config/amplify-outputs branch August 7, 2024 16:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(core): add AmplifyOutputs types based on the Amplify Gen 2 client config schema #4859

feat(core): add AmplifyOutputs types based on the Amplify Gen 2 client config schema #4859

NikaHsn commented May 8, 2024 •

edited

Loading

Jordan-Nelson May 10, 2024

Jordan-Nelson May 10, 2024

Jordan-Nelson May 10, 2024

Jordan-Nelson May 10, 2024

NikaHsn May 21, 2024

Jordan-Nelson May 10, 2024

Jordan-Nelson May 10, 2024

Jordan-Nelson May 10, 2024

	/// The amplify outputs generated by Amplify CLI Gen2 for
	/// The amplify outputs generated by Amplify Gen 2 for

	/// The custom outputs generated by CLI Gen2.
	/// The custom outputs generated by Amplify Gen 2.

		/// The Amazon Pinpoint outputs used by Analytics category plugin
		/// to communicate with backend services.

	/// The Amazon Pinpoint outputs used by Analytics category plugin
	/// to communicate with backend services.
	/// The Amplify Gen 2 output for Amazon Pinpoint.

		/// The MFA method of Amazon Cognito User Pool for
		/// sending the authorization code.

feat(core): add AmplifyOutputs types based on the Amplify Gen 2 client config schema #4859

feat(core): add AmplifyOutputs types based on the Amplify Gen 2 client config schema #4859

Conversation

NikaHsn commented May 8, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NikaHsn commented May 8, 2024 •

edited

Loading