From 2088b9174b94e743aae585c1257c4080685b7c9d Mon Sep 17 00:00:00 2001 From: Kha Truong <64438356+khatruong2009@users.noreply.github.com> Date: Wed, 19 Jun 2024 13:54:38 -0700 Subject: [PATCH 1/6] chore: change outputs to amplifyConfig in flutter gen 2 docs --- .../add-aws-services/analytics/set-up-analytics/index.mdx | 2 +- src/pages/[platform]/build-a-backend/data/set-up-data/index.mdx | 2 +- .../[platform]/build-a-backend/storage/set-up-storage/index.mdx | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/pages/[platform]/build-a-backend/add-aws-services/analytics/set-up-analytics/index.mdx b/src/pages/[platform]/build-a-backend/add-aws-services/analytics/set-up-analytics/index.mdx index 6c4d61a2d6f..dba46c789b2 100644 --- a/src/pages/[platform]/build-a-backend/add-aws-services/analytics/set-up-analytics/index.mdx +++ b/src/pages/[platform]/build-a-backend/add-aws-services/analytics/set-up-analytics/index.mdx @@ -333,7 +333,7 @@ Future _configureAmplify() async { // Once Plugins are added, configure Amplify // Note: Amplify can only be configured once. try { - await Amplify.configure(outputs); + await Amplify.configure(amplifyConfig); } on AmplifyAlreadyConfiguredException { safePrint( 'Tried to reconfigure Amplify; this can occur when your app restarts on Android.', diff --git a/src/pages/[platform]/build-a-backend/data/set-up-data/index.mdx b/src/pages/[platform]/build-a-backend/data/set-up-data/index.mdx index 55c396b77fb..51e1157542e 100644 --- a/src/pages/[platform]/build-a-backend/data/set-up-data/index.mdx +++ b/src/pages/[platform]/build-a-backend/data/set-up-data/index.mdx @@ -341,7 +341,7 @@ Future main() async { try { final api = AmplifyAPI(modelProvider: ModelProvider.instance); await Amplify.addPlugins([api]); - await Amplify.configure(outputs); + await Amplify.configure(amplifyConfig); safePrint('Successfully configured Amplify'); } on Exception catch (e) { diff --git a/src/pages/[platform]/build-a-backend/storage/set-up-storage/index.mdx b/src/pages/[platform]/build-a-backend/storage/set-up-storage/index.mdx index ebb27227d3b..b66ded147a5 100644 --- a/src/pages/[platform]/build-a-backend/storage/set-up-storage/index.mdx +++ b/src/pages/[platform]/build-a-backend/storage/set-up-storage/index.mdx @@ -455,7 +455,7 @@ Future _configureAmplify() async { await Amplify.addPlugins([auth, storage]); // call Amplify.configure to use the initialized categories in your app - await Amplify.configure(outputs); + await Amplify.configure(amplifyConfig); } on Exception catch (e) { safePrint('An error occurred configuring Amplify: $e'); } From 6680d2f9057aa0bbe45c06ffef65b2a6d81d9142 Mon Sep 17 00:00:00 2001 From: Kha Truong <64438356+khatruong2009@users.noreply.github.com> Date: Wed, 19 Jun 2024 16:16:34 -0700 Subject: [PATCH 2/6] chore: change amplifyconfiguration.dart import to amplify_outputs.dart --- .../add-aws-services/analytics/set-up-analytics/index.mdx | 8 ++++---- .../[platform]/build-a-backend/auth/set-up-auth/index.mdx | 4 ++-- .../[platform]/build-a-backend/data/set-up-data/index.mdx | 2 +- .../build-a-backend/storage/set-up-storage/index.mdx | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/pages/[platform]/build-a-backend/add-aws-services/analytics/set-up-analytics/index.mdx b/src/pages/[platform]/build-a-backend/add-aws-services/analytics/set-up-analytics/index.mdx index dba46c789b2..b6ca288e84f 100644 --- a/src/pages/[platform]/build-a-backend/add-aws-services/analytics/set-up-analytics/index.mdx +++ b/src/pages/[platform]/build-a-backend/add-aws-services/analytics/set-up-analytics/index.mdx @@ -300,7 +300,7 @@ import 'package:amplify_auth_cognito/amplify_auth_cognito.dart'; import 'package:amplify_flutter/amplify_flutter.dart'; import 'package:flutter/material.dart'; -import 'amplifyconfiguration.dart'; +import 'amplify_outputs.dart'; Future _configureAmplify() async { // Add Pinpoint and Cognito Plugins, and any other plugins you want to use @@ -324,7 +324,7 @@ import 'package:amplify_auth_cognito/amplify_auth_cognito.dart'; import 'package:amplify_flutter/amplify_flutter.dart'; import 'package:flutter/material.dart'; -import 'amplifyconfiguration.dart'; +import 'amplify_outputs.dart'; Future _configureAmplify() async { // ... @@ -350,7 +350,7 @@ import 'package:amplify_analytics_pinpoint/amplify_analytics_pinpoint.dart'; import 'package:amplify_auth_cognito/amplify_auth_cognito.dart'; import 'package:flutter/material.dart'; -import 'amplifyconfiguration.dart'; +import 'amplify_outputs.dart'; Future _configureAmplify() async { // Add any Amplify plugins you want to use @@ -361,7 +361,7 @@ Future _configureAmplify() async { // Once Plugins are added, configure Amplify // Note: Amplify can only be configured once. try { - await Amplify.configure(outputs); + await Amplify.configure(amplifyConfig); } on AmplifyAlreadyConfiguredException { safePrint( 'Tried to reconfigure Amplify; this can occur when your app restarts on Android.', diff --git a/src/pages/[platform]/build-a-backend/auth/set-up-auth/index.mdx b/src/pages/[platform]/build-a-backend/auth/set-up-auth/index.mdx index 6b3ba176d93..0585eed84db 100644 --- a/src/pages/[platform]/build-a-backend/auth/set-up-auth/index.mdx +++ b/src/pages/[platform]/build-a-backend/auth/set-up-auth/index.mdx @@ -394,7 +394,7 @@ import 'package:amplify_authenticator/amplify_authenticator.dart'; import 'package:amplify_flutter/amplify_flutter.dart'; import 'package:flutter/material.dart'; -import 'amplifyconfiguration.dart'; +import 'amplify_outputs.dart'; Future main() async { try { @@ -410,7 +410,7 @@ Future main() async { Future _configureAmplify() async { try { await Amplify.addPlugin(AmplifyAuthCognito()); - await Amplify.configure(outputs); + await Amplify.configure(amplifyConfig); safePrint('Successfully configured'); } on Exception catch (e) { safePrint('Error configuring Amplify: $e'); diff --git a/src/pages/[platform]/build-a-backend/data/set-up-data/index.mdx b/src/pages/[platform]/build-a-backend/data/set-up-data/index.mdx index 51e1157542e..020a66c5ef7 100644 --- a/src/pages/[platform]/build-a-backend/data/set-up-data/index.mdx +++ b/src/pages/[platform]/build-a-backend/data/set-up-data/index.mdx @@ -332,7 +332,7 @@ import 'package:amplify_flutter/amplify_flutter.dart'; import 'package:flutter/material.dart'; // highlight-start -import 'amplifyconfiguration.dart'; +import 'amplify_outputs.dart'; import 'models/ModelProvider.dart'; // highlight-end diff --git a/src/pages/[platform]/build-a-backend/storage/set-up-storage/index.mdx b/src/pages/[platform]/build-a-backend/storage/set-up-storage/index.mdx index b66ded147a5..0918ea16bbe 100644 --- a/src/pages/[platform]/build-a-backend/storage/set-up-storage/index.mdx +++ b/src/pages/[platform]/build-a-backend/storage/set-up-storage/index.mdx @@ -446,7 +446,7 @@ import 'package:amplify_flutter/amplify_flutter.dart'; import 'package:amplify_storage_s3/amplify_storage_s3.dart'; import 'package:flutter/material.dart'; -import 'amplifyconfiguration.dart'; +import 'amplify_outputs.dart'; Future _configureAmplify() async { try { From ce3496470290e0fc9ac9e5694496d7298b0a3d4e Mon Sep 17 00:00:00 2001 From: Kha Truong <64438356+khatruong2009@users.noreply.github.com> Date: Wed, 19 Jun 2024 16:17:11 -0700 Subject: [PATCH 3/6] chore: remove --outputs-version 0 and downgrade config file callout --- src/pages/[platform]/start/quickstart/index.mdx | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/src/pages/[platform]/start/quickstart/index.mdx b/src/pages/[platform]/start/quickstart/index.mdx index 9a41210aeff..aecc0f98ca6 100644 --- a/src/pages/[platform]/start/quickstart/index.mdx +++ b/src/pages/[platform]/start/quickstart/index.mdx @@ -1313,14 +1313,9 @@ npx ampx sandbox ```bash title="Terminal" showLineNumbers={false} -npx ampx sandbox --outputs-format dart --outputs-out-dir lib --outputs-version 0 +npx ampx sandbox --outputs-format dart --outputs-out-dir lib ``` - - -**Note:** when using Amplify Gen 2 with Flutter, you must downgrade the generated client configuration file (`amplify_outputs.dart`) with [`--outputs-version 0`](/[platform]/reference/cli-commands/#npx-ampx-generate-outputs) - - ## Adding Authentication @@ -1358,7 +1353,7 @@ import 'package:amplify_authenticator/amplify_authenticator.dart'; import 'package:amplify_flutter/amplify_flutter.dart'; import 'package:flutter/material.dart'; -import 'amplifyconfiguration.dart'; +import 'amplify_outputs.dart'; Future main() async { try { From 731b384a1348b236cd49fff37d7130ec52f9fa23 Mon Sep 17 00:00:00 2001 From: Kha Truong <64438356+khatruong2009@users.noreply.github.com> Date: Fri, 28 Jun 2024 10:24:15 -0700 Subject: [PATCH 4/6] chore: remove --outputs-version 0 from snippets --- src/pages/[platform]/build-a-backend/auth/set-up-auth/index.mdx | 2 +- src/pages/[platform]/reference/cli-commands/index.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/pages/[platform]/build-a-backend/auth/set-up-auth/index.mdx b/src/pages/[platform]/build-a-backend/auth/set-up-auth/index.mdx index 0585eed84db..e8df0fbc6f0 100644 --- a/src/pages/[platform]/build-a-backend/auth/set-up-auth/index.mdx +++ b/src/pages/[platform]/build-a-backend/auth/set-up-auth/index.mdx @@ -69,7 +69,7 @@ npx ampx sandbox ```bash title="Terminal" showLineNumbers={false} -npx ampx sandbox --outputs-format dart --outputs-out-dir lib --outputs-version 0 +npx ampx sandbox --outputs-format dart --outputs-out-dir lib ``` diff --git a/src/pages/[platform]/reference/cli-commands/index.mdx b/src/pages/[platform]/reference/cli-commands/index.mdx index 4e2c576c09a..216be33f4e5 100644 --- a/src/pages/[platform]/reference/cli-commands/index.mdx +++ b/src/pages/[platform]/reference/cli-commands/index.mdx @@ -101,7 +101,7 @@ npx ampx sandbox ```bash title="Terminal" showLineNumbers={false} # for Flutter -npx ampx sandbox --outputs-format dart --outputs-out-dir lib --outputs-version 0 +npx ampx sandbox --outputs-format dart --outputs-out-dir lib ``` ## npx ampx sandbox delete From f1ac906538998df50f89777dbefe392841781649 Mon Sep 17 00:00:00 2001 From: Kha Truong <64438356+khatruong2009@users.noreply.github.com> Date: Fri, 28 Jun 2024 10:36:42 -0700 Subject: [PATCH 5/6] chore: remove gen 2 config conversion callout --- .../[platform]/build-a-backend/auth/set-up-auth/index.mdx | 6 ------ 1 file changed, 6 deletions(-) diff --git a/src/pages/[platform]/build-a-backend/auth/set-up-auth/index.mdx b/src/pages/[platform]/build-a-backend/auth/set-up-auth/index.mdx index e8df0fbc6f0..1903fe1750c 100644 --- a/src/pages/[platform]/build-a-backend/auth/set-up-auth/index.mdx +++ b/src/pages/[platform]/build-a-backend/auth/set-up-auth/index.mdx @@ -72,12 +72,6 @@ npx ampx sandbox npx ampx sandbox --outputs-format dart --outputs-out-dir lib ``` - - -**Note:** when using Amplify Gen 2 with Flutter, you must downgrade the generated client configuration file (`amplify_outputs.dart`) with [`--outputs-version 0`](/[platform]/reference/cli-commands/#npx-ampx-generate-outputs) - - - From c04b682d79de0072aa08aa56e9ea8aa2fb2681fe Mon Sep 17 00:00:00 2001 From: Kha Truong <64438356+khatruong2009@users.noreply.github.com> Date: Fri, 28 Jun 2024 10:50:24 -0700 Subject: [PATCH 6/6] chore: remove amplifyconfiguration.dart references from gen 2 --- .../add-aws-services/analytics/record-events/index.mdx | 2 +- .../add-aws-services/analytics/set-up-analytics/index.mdx | 2 +- .../build-a-backend/storage/use-with-custom-s3/index.mdx | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/pages/[platform]/build-a-backend/add-aws-services/analytics/record-events/index.mdx b/src/pages/[platform]/build-a-backend/add-aws-services/analytics/record-events/index.mdx index 3c7017249f0..cb02018a996 100644 --- a/src/pages/[platform]/build-a-backend/add-aws-services/analytics/record-events/index.mdx +++ b/src/pages/[platform]/build-a-backend/add-aws-services/analytics/record-events/index.mdx @@ -305,7 +305,7 @@ However, it can take upwards of 30 minutes for the event to display in the Filte ## Flush events -Events have default configuration to flush out to the network every 30 seconds. If you would like to change this, update `amplifyconfiguration.dart` with the value in milliseconds you would like for `autoFlushEventsInterval`. This configuration will flush events every 10 seconds: +Events have default configuration to flush out to the network every 30 seconds. If you would like to change this, update `amplify_outputs.dart` with the value in milliseconds you would like for `autoFlushEventsInterval`. This configuration will flush events every 10 seconds: ```json { diff --git a/src/pages/[platform]/build-a-backend/add-aws-services/analytics/set-up-analytics/index.mdx b/src/pages/[platform]/build-a-backend/add-aws-services/analytics/set-up-analytics/index.mdx index b6ca288e84f..34d70a829c4 100644 --- a/src/pages/[platform]/build-a-backend/add-aws-services/analytics/set-up-analytics/index.mdx +++ b/src/pages/[platform]/build-a-backend/add-aws-services/analytics/set-up-analytics/index.mdx @@ -316,7 +316,7 @@ When running your app on macOS you will need to enable keychain sharing in Xcode -Make sure that the amplifyconfiguration.dart file generated in the project setup is included and sent to Amplify.configure: +Make sure that the amplify_outputs.dart file generated in the project setup is included and sent to Amplify.configure: ```dart import 'package:amplify_analytics_pinpoint/amplify_analytics_pinpoint.dart'; diff --git a/src/pages/[platform]/build-a-backend/storage/use-with-custom-s3/index.mdx b/src/pages/[platform]/build-a-backend/storage/use-with-custom-s3/index.mdx index fdfa9ee9621..0df45abfa00 100644 --- a/src/pages/[platform]/build-a-backend/storage/use-with-custom-s3/index.mdx +++ b/src/pages/[platform]/build-a-backend/storage/use-with-custom-s3/index.mdx @@ -120,9 +120,9 @@ To ensure the local **amplify_outputs.json** file is up-to-date, you can run [th -## Step 3 - Import latest amplifyconfiguration.dart file +## Step 3 - Import latest amplify_outputs.dart file -To ensure the local **amplifyconfiguration.dart** file is up-to-date, you can run [the npx ampx generate outputs command](/[platform]/reference/cli-commands/#npx-ampx-generate-outputs). +To ensure the local **amplify_outputs.dart** file is up-to-date, you can run [the npx ampx generate outputs command](/[platform]/reference/cli-commands/#npx-ampx-generate-outputs).