Fix: relax config for AmplifyOutputs #13234
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
calebpollman
reviewed
Apr 9, 2024
| @@ -38,19 +30,19 @@ export interface AmplifyOutputsAuthProperties { | |||
| require_symbols: boolean; | |||
| }; | |||
| oauth?: { | |||
| identity_providers: AmplifyOutputsOAuthIdentityProvider[]; | |||
| identity_providers: string[]; | |||
There was a problem hiding this comment.
Why are we making this change?
There was a problem hiding this comment.
TypeScript complains when importing the JSON file
cshfang
approved these changes
Apr 10, 2024
| @@ -130,34 +127,27 @@ function parseAuth( | |||
| domain: oauth.domain, | |||
| redirectSignIn: oauth.redirect_sign_in_uri, | |||
| redirectSignOut: oauth.redirect_sign_out_uri, | |||
| responseType: oauth.response_type, | |||
| responseType: oauth.response_type === 'token' ? 'token' : 'code', | |||
There was a problem hiding this comment.
Nit: What might this be other than 'token'? Just wondering if we can just do
responseType: oauth.response_type ?? 'code',There was a problem hiding this comment.
I want to show both options to make it more readable
ashika112
reviewed
Apr 10, 2024
| @@ -0,0 +1,72 @@ | |||
| { | |||
ashika112
approved these changes
Apr 10, 2024
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of changes
Relax types of
AmplifyOutputsto prevent TypeScript problems while importing JSON file, also updating with latests schema.{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://amplify.aws/2024-02/outputs-schema.json", "title": "AWS Amplify Backend Outputs", "description": "Config format for Amplify Gen 2 client libraries to communicate with backend services.", "type": "object", "additionalProperties": false, "properties": { "$schema": { "description": "JSON schema", "type": "string" }, "version": { "description": "Version of this schema", "const": "1" }, "analytics": { "description": "Outputs manually specified by developers for use with frontend library", "type": "object", "additionalProperties": false, "properties": { "amazon_pinpoint": { "type": "object", "additionalProperties": false, "properties": { "aws_region": { "description": "AWS Region of Amazon Pinpoint resources", "$ref": "#/$defs/aws_region" }, "app_id": { "type": "string" } }, "required": ["aws_region", "app_id"] } } }, "auth": { "description": "Outputs generated from defineAuth", "type": "object", "additionalProperties": false, "properties": { "aws_region": { "description": "AWS Region of Amazon Cognito resources", "$ref": "#/$defs/aws_region" }, "authentication_flow_type": { "description": "Authentication flow types", "type": "string", "enum": ["USER_SRP_AUTH", "CUSTOM_AUTH"], "default": "USER_SRP_AUTH" }, "user_pool_id": { "description": "Cognito User Pool ID", "type": "string" }, "user_pool_client_id": { "description": "Cognito User Pool Client ID", "type": "string" }, "identity_pool_id": { "description": "Cognito Identity Pool ID", "type": "string" }, "password_policy": { "description": "Cognito User Pool password policy", "type": "object", "additionalProperties": false, "properties": { "min_length": { "type": "integer", "minimum": 6, "maximum": 99 }, "require_numbers": { "type": "boolean" }, "require_lowercase": { "type": "boolean" }, "require_uppercase": { "type": "boolean" }, "require_symbols": { "type": "boolean" } } }, "oauth": { "type": "object", "additionalProperties": false, "properties": { "identity_providers": { "description": "Identity providers set on Cognito User Pool", "type": "array", "items": { "type": "string", "enum": [ "GOOGLE", "FACEBOOK", "LOGIN_WITH_AMAZON", "SIGN_IN_WITH_APPLE" ] }, "minItems": 0, "uniqueItems": true }, "domain": { "description": "Cognito Domain used for identity providers", "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" }, "minItems": 0, "uniqueItems": true }, "redirect_sign_in_uri": { "description": "URIs used to redirect after signing in using an identity provider", "type": "array", "items": { "type": "string" }, "minItems": 1, "uniqueItems": true }, "redirect_sign_out_uri": { "description": "URIs used to redirect after signing out", "type": "array", "items": { "type": "string" }, "minItems": 1, "uniqueItems": true }, "response_type": { "type": "string", "enum": ["code", "token"] } }, "required": [ "identity_providers", "scopes", "redirect_sign_in_uri", "redirect_sign_out_uri", "response_type" ] }, "standard_required_attributes": { "description": "Cognito User Pool standard attributes required for signup", "type": "array", "items": { "$ref": "#/$defs/amazon_cognito_standard_attributes" }, "minItems": 0, "uniqueItems": true }, "username_attributes": { "description": "Cognito User Pool username attributes", "type": "array", "items": { "type": "string", "enum": ["email", "phone_number"] }, "minItems": 1, "uniqueItems": true }, "user_verification_types": { "type": "array", "items": { "type": "string", "enum": ["email", "phone_number"] } }, "unauthenticated_identities_enabled": { "type": "boolean", "default": true }, "mfa_configuration": { "type": "string", "enum": ["NONE", "OPTIONAL", "REQUIRED"] }, "mfa_methods": { "type": "array", "items": { "enum": ["SMS", "TOTP"] } } }, "required": ["aws_region", "user_pool_id", "user_pool_client_id"] }, "data": { "description": "Outputs generated from defineData", "type": "object", "additionalProperties": false, "properties": { "aws_region": { "$ref": "#/$defs/aws_region" }, "url": { "description": "AppSync endpoint URL", "type": "string" }, "model_introspection": { "description": "generated model introspection schema for use with generateClient", "type": "object" }, "api_key": { "type": "string" }, "default_authorization_type": { "$ref": "#/$defs/aws_appsync_authorization_type" }, "authorization_types": { "type": "array", "items": { "$ref": "#/$defs/aws_appsync_authorization_type" } } }, "required": [ "aws_region", "url", "default_authorization_type", "authorization_types" ] }, "geo": { "description": "Outputs manually specified by developers for use with frontend library", "type": "object", "additionalProperties": false, "properties": { "aws_region": { "description": "AWS Region of Amazon Location Service resources", "$ref": "#/$defs/aws_region" }, "maps": { "description": "Maps from Amazon Location Service", "type": "object", "additionalProperties": false, "properties": { "items": { "type": "object", "additionalProperties": false, "propertyNames": { "description": "Amazon Location Service Map name", "type": "string" }, "patternProperties": { ".*": { "$ref": "#/$defs/amazon_location_service_config" } } }, "default": { "type": "string" } }, "required": ["items", "default"] }, "search_indices": { "description": "Location search (search by places, addresses, coordinates)", "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "description": "Actual search name", "type": "string" } }, "default": { "type": "string" } }, "required": ["items", "default"] }, "geofence_collections": { "description": "Geofencing (visualize virtual perimeters)", "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "description": "Geofence name", "type": "string" } }, "default": { "type": "string" } }, "required": ["items", "default"] } }, "required": ["aws_region"] }, "notifications": { "type": "object", "description": "Outputs manually specified by developers for use with frontend library", "additionalProperties": false, "properties": { "aws_region": { "$ref": "#/$defs/aws_region" }, "amazon_pinpoint_app_id": { "type": "string" }, "channels": { "type": "array", "items": { "$ref": "#/$defs/amazon_pinpoint_channels" }, "minItems": 1, "uniqueItems": true } }, "required": ["aws_region", "amazon_pinpoint_app_id", "channels"] }, "storage": { "type": "object", "description": "Outputs generated from defineStorage", "additionalProperties": false, "properties": { "aws_region": { "$ref": "#/$defs/aws_region" }, "bucket_name": { "type": "string" } }, "required": ["aws_region", "bucket_name"] }, "custom": { "description": "Outputs generated from backend.addOutput({ custom: <config> })", "type": "object" } }, "required": ["version"], "$defs": { "aws_region": { "type": "string" }, "amazon_cognito_standard_attributes": { "description": "Amazon Cognito standard attributes for users -- https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html", "type": "string", "enum": [ "address", "birthdate", "email", "family_name", "gender", "given_name", "locale", "middle_name", "name", "nickname", "phone_number", "picture", "preferred_username", "profile", "sub", "updated_at", "website", "zoneinfo" ] }, "aws_appsync_authorization_type": { "description": "List of supported auth types for AWS AppSync", "type": "string", "enum": [ "AMAZON_COGNITO_USER_POOLS", "API_KEY", "AWS_IAM", "AWS_LAMBDA", "OPENID_CONNECT" ] }, "amazon_location_service_config": { "type": "object", "additionalProperties": false, "properties": { "style": { "description": "Map style", "type": "string" } } }, "amazon_pinpoint_channels": { "description": "supported channels for Amazon Pinpoint", "type": "string", "enum": ["IN_APP_MESSAGING", "FCM", "APNS", "EMAIL", "SMS"] } } }Issue #, if available
Description of how you validated changes
Checklist
yarn testpassesBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.