@aws-amplify/adapter-nextjs 0.0.2-console-preview.1053355.0 → 0.0.2-console-preview.957cda4.0

package/lib/runWithAmplifyServerContext.js

@@ -51,12 +51,13 @@ var runWithAmplifyServerContext = function (_a) {
             // When the Auth config is presented, attempt to create a Amplify server
             // context with token and credentials provider.
             if (amplifyConfig.Auth) {
-                keyValueStorage = nextServerContext === null
-                    ? // When `null` is passed as the value of `nextServerContext`, opt-in
-                        // unauthenticated role (primarily for static rendering). It's
-                        // safe to use the singleton `MemoryKeyValueStorage` here, as the
-                        // static rendering uses the same unauthenticated role cross-sever.
-                        core_1.MemoryKeyValueStorage
+                keyValueStorage = 
+                // When `null` is passed as the value of `nextServerContext`, opt-in
+                // unauthenticated role (primarily for static rendering). It's
+                // safe to use the singleton `MemoryKeyValueStorage` here, as the
+                // static rendering uses the same unauthenticated role cross-sever.
+                nextServerContext === null
+                    ? core_1.MemoryKeyValueStorage
                     : (0, adapter_core_1.createKeyValueStorageFromCookieStorageAdapter)((0, utils_1.createCookieStorageAdapterFromNextServerContext)(nextServerContext));
                 credentialsProvider = (0, adapter_core_1.createAWSCredentialsAndIdentityIdProvider)(amplifyConfig.Auth, keyValueStorage);
                 tokenProvider = (0, adapter_core_1.createUserPoolsTokenProvider)(amplifyConfig.Auth, keyValueStorage);

package/lib/runWithAmplifyServerContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"runWithAmplifyServerContext.js","sourceRoot":"","sources":["../src/runWithAmplifyServerContext.ts"],"names":[],"mappings":";AAAA,qEAAqE;AACrE,sCAAsC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGtC,iCAGiB;AACjB,0CAA0D;AAC1D,mEAK4C;AAErC,IAAM,2BAA2B,GACvC,UAAO,EAAgC;QAA9B,iBAAiB,uBAAA,EAAE,SAAS,eAAA;;;;YAM9B,aAAa,GAAG,IAAA,wBAAgB,GAAE,CAAC;YAEzC,wEAAwE;YACxE,+CAA+C;YAC/C,IAAI,aAAa,CAAC,IAAI,EAAE;gBACjB,eAAe,GACpB,iBAAiB,KAAK,IAAI;oBACzB,CAAC,CAAC,oEAAoE;wBACpE,8DAA8D;wBAC9D,iEAAiE;wBACjE,mEAAmE;wBACnE,4BAAqB;oBACvB,CAAC,CAAC,IAAA,4DAA6C,EAC7C,IAAA,uDAA+C,EAAC,iBAAiB,CAAC,CACjE,CAAC;gBACA,mBAAmB,GAAG,IAAA,wDAAyC,EACpE,aAAa,CAAC,IAAI,EAClB,eAAe,CACf,CAAC;gBACI,aAAa,GAAG,IAAA,2CAA4B,EACjD,aAAa,CAAC,IAAI,EAClB,eAAe,CACf,CAAC;gBAEF,sBAAO,IAAA,0CAA+B,EACrC,aAAa,EACb;wBACC,IAAI,EAAE,EAAE,mBAAmB,qBAAA,EAAE,aAAa,eAAA,EAAE;qBAC5C,EACD,SAAS,CACT,EAAC;aACF;YAED,oEAAoE;YACpE,+CAA+C;YAC/C,sBAAO,IAAA,0CAA+B,EAAC,aAAa,EAAE,EAAE,EAAE,SAAS,CAAC,EAAC;;;CACrE,CAAC;AA3CU,QAAA,2BAA2B,+BA2CrC"}
+{"version":3,"file":"runWithAmplifyServerContext.js","sourceRoot":"","sources":["../src/runWithAmplifyServerContext.ts"],"names":[],"mappings":";AAAA,qEAAqE;AACrE,sCAAsC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGtC,iCAGiB;AACjB,0CAA0D;AAC1D,mEAK4C;AAErC,IAAM,2BAA2B,GACvC,UAAO,EAAgC;QAA9B,iBAAiB,uBAAA,EAAE,SAAS,eAAA;;;;YAM9B,aAAa,GAAG,IAAA,wBAAgB,GAAE,CAAC;YAEzC,wEAAwE;YACxE,+CAA+C;YAC/C,IAAI,aAAa,CAAC,IAAI,EAAE;gBACjB,eAAe;gBACpB,oEAAoE;gBACpE,8DAA8D;gBAC9D,iEAAiE;gBACjE,mEAAmE;gBACnE,iBAAiB,KAAK,IAAI;oBACzB,CAAC,CAAC,4BAAqB;oBACvB,CAAC,CAAC,IAAA,4DAA6C,EAC7C,IAAA,uDAA+C,EAAC,iBAAiB,CAAC,CACjE,CAAC;gBACA,mBAAmB,GAAG,IAAA,wDAAyC,EACpE,aAAa,CAAC,IAAI,EAClB,eAAe,CACf,CAAC;gBACI,aAAa,GAAG,IAAA,2CAA4B,EACjD,aAAa,CAAC,IAAI,EAClB,eAAe,CACf,CAAC;gBAEF,sBAAO,IAAA,0CAA+B,EACrC,aAAa,EACb;wBACC,IAAI,EAAE,EAAE,mBAAmB,qBAAA,EAAE,aAAa,eAAA,EAAE;qBAC5C,EACD,SAAS,CACT,EAAC;aACF;YAED,oEAAoE;YACpE,+CAA+C;YAC/C,sBAAO,IAAA,0CAA+B,EAAC,aAAa,EAAE,EAAE,EAAE,SAAS,CAAC,EAAC;;;CACrE,CAAC;AA3CU,QAAA,2BAA2B,+BA2CrC"}

package/lib/utils/getAmplifyConfig.d.ts

@@ -1,2 +1,2 @@
-import { ResourcesConfig } from '@aws-amplify/core';
+import { ResourcesConfig } from 'aws-amplify';
 export declare const getAmplifyConfig: () => ResourcesConfig;

package/lib/withAmplify.d.ts

@@ -1,9 +1,22 @@
-import { ResourcesConfig } from '@aws-amplify/core';
+import { ResourcesConfig } from 'aws-amplify';
 import { NextConfig } from 'next';
 /**
  * Merges the `amplifyConfig` into the `nextConfig.env`.
+ *
  * @param nextConfig The next config for a Next.js app.
- * @param amplifyConfig
+ * @param amplifyConfig The Amplify configuration.
+ *
+ *   **NOTE**: If you are using Amplify CLI to generate the `aws-exports.js`
+ *   file, you need to use {@link parseAmplifyConfig} to reformat the configuration.
+ *   E.g.
+ *   ```javascript
+ *   const { parseAmplifyConfig } = require('aws-amplify');
+ *   const { withAmplify } = require('@aws-amplify/adapter-nextjs/with-amplify');
+ *   const config = require('./src/aws-exports');
+ *
+ *   const nextConfig = {};
+ *   module.exports = withAmplify(nextConfig, parseAmplifyConfig(config));
+ *   ```
  * @returns The updated `nextConfig`.
  */
 export declare const withAmplify: (nextConfig: NextConfig, amplifyConfig: ResourcesConfig) => NextConfig;

package/lib/withAmplify.js

@@ -19,14 +19,25 @@ exports.withAmplify = void 0;
 // is not being transpiled by Next.js.
 /**
  * Merges the `amplifyConfig` into the `nextConfig.env`.
+ *
  * @param nextConfig The next config for a Next.js app.
- * @param amplifyConfig
+ * @param amplifyConfig The Amplify configuration.
+ *
+ *   **NOTE**: If you are using Amplify CLI to generate the `aws-exports.js`
+ *   file, you need to use {@link parseAmplifyConfig} to reformat the configuration.
+ *   E.g.
+ *   ```javascript
+ *   const { parseAmplifyConfig } = require('aws-amplify');
+ *   const { withAmplify } = require('@aws-amplify/adapter-nextjs/with-amplify');
+ *   const config = require('./src/aws-exports');
+ *
+ *   const nextConfig = {};
+ *   module.exports = withAmplify(nextConfig, parseAmplifyConfig(config));
+ *   ```
  * @returns The updated `nextConfig`.
  */
 var withAmplify = function (nextConfig, amplifyConfig) {
-    nextConfig.env = __assign(__assign({}, nextConfig.env), { 
-        // TODO(Hui): follow up the validation of the amplifyConfig.
-        amplifyConfig: JSON.stringify(amplifyConfig) });
+    nextConfig.env = __assign(__assign({}, nextConfig.env), { amplifyConfig: JSON.stringify(amplifyConfig) });
     return nextConfig;
 };
 exports.withAmplify = withAmplify;

package/lib/withAmplify.js.map

@@ -1 +1 @@
-{"version":3,"file":"withAmplify.js","sourceRoot":"","sources":["../src/withAmplify.ts"],"names":[],"mappings":";AAAA,qEAAqE;AACrE,sCAAsC;;;;;;;;;;;;;;AAKtC,oEAAoE;AACpE,2EAA2E;AAC3E,sCAAsC;AAEtC;;;;;GAKG;AACI,IAAM,WAAW,GAAG,UAC1B,UAAsB,EACtB,aAA8B;IAE9B,UAAU,CAAC,GAAG,yBACV,UAAU,CAAC,GAAG;QACjB,4DAA4D;QAC5D,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,GAC5C,CAAC;IAEF,OAAO,UAAU,CAAC;AACnB,CAAC,CAAC;AAXW,QAAA,WAAW,eAWtB"}
+{"version":3,"file":"withAmplify.js","sourceRoot":"","sources":["../src/withAmplify.ts"],"names":[],"mappings":";AAAA,qEAAqE;AACrE,sCAAsC;;;;;;;;;;;;;;AAKtC,oEAAoE;AACpE,2EAA2E;AAC3E,sCAAsC;AAEtC;;;;;;;;;;;;;;;;;;GAkBG;AACI,IAAM,WAAW,GAAG,UAC1B,UAAsB,EACtB,aAA8B;IAE9B,UAAU,CAAC,GAAG,yBACV,UAAU,CAAC,GAAG,KACjB,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,GAC5C,CAAC;IAEF,OAAO,UAAU,CAAC;AACnB,CAAC,CAAC;AAVW,QAAA,WAAW,eAUtB"}

package/lib-esm/runWithAmplifyServerContext.js

@@ -48,12 +48,13 @@ export var runWithAmplifyServerContext = function (_a) {
             // When the Auth config is presented, attempt to create a Amplify server
             // context with token and credentials provider.
             if (amplifyConfig.Auth) {
-                keyValueStorage = nextServerContext === null
-                    ? // When `null` is passed as the value of `nextServerContext`, opt-in
-                        // unauthenticated role (primarily for static rendering). It's
-                        // safe to use the singleton `MemoryKeyValueStorage` here, as the
-                        // static rendering uses the same unauthenticated role cross-sever.
-                        MemoryKeyValueStorage
+                keyValueStorage = 
+                // When `null` is passed as the value of `nextServerContext`, opt-in
+                // unauthenticated role (primarily for static rendering). It's
+                // safe to use the singleton `MemoryKeyValueStorage` here, as the
+                // static rendering uses the same unauthenticated role cross-sever.
+                nextServerContext === null
+                    ? MemoryKeyValueStorage
                     : createKeyValueStorageFromCookieStorageAdapter(createCookieStorageAdapterFromNextServerContext(nextServerContext));
                 credentialsProvider = createAWSCredentialsAndIdentityIdProvider(amplifyConfig.Auth, keyValueStorage);
                 tokenProvider = createUserPoolsTokenProvider(amplifyConfig.Auth, keyValueStorage);

package/lib-esm/runWithAmplifyServerContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"runWithAmplifyServerContext.js","sourceRoot":"","sources":["../src/runWithAmplifyServerContext.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGtC,OAAO,EACN,+CAA+C,EAC/C,gBAAgB,GAChB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,EACN,yCAAyC,EACzC,6CAA6C,EAC7C,4BAA4B,EAC5B,2BAA2B,IAAI,+BAA+B,GAC9D,MAAM,oCAAoC,CAAC;AAE5C,MAAM,CAAC,IAAM,2BAA2B,GACvC,UAAO,EAAgC;QAA9B,iBAAiB,uBAAA,EAAE,SAAS,eAAA;;;;YAM9B,aAAa,GAAG,gBAAgB,EAAE,CAAC;YAEzC,wEAAwE;YACxE,+CAA+C;YAC/C,IAAI,aAAa,CAAC,IAAI,EAAE;gBACjB,eAAe,GACpB,iBAAiB,KAAK,IAAI;oBACzB,CAAC,CAAC,oEAAoE;wBACpE,8DAA8D;wBAC9D,iEAAiE;wBACjE,mEAAmE;wBACnE,qBAAqB;oBACvB,CAAC,CAAC,6CAA6C,CAC7C,+CAA+C,CAAC,iBAAiB,CAAC,CACjE,CAAC;gBACA,mBAAmB,GAAG,yCAAyC,CACpE,aAAa,CAAC,IAAI,EAClB,eAAe,CACf,CAAC;gBACI,aAAa,GAAG,4BAA4B,CACjD,aAAa,CAAC,IAAI,EAClB,eAAe,CACf,CAAC;gBAEF,sBAAO,+BAA+B,CACrC,aAAa,EACb;wBACC,IAAI,EAAE,EAAE,mBAAmB,qBAAA,EAAE,aAAa,eAAA,EAAE;qBAC5C,EACD,SAAS,CACT,EAAC;aACF;YAED,oEAAoE;YACpE,+CAA+C;YAC/C,sBAAO,+BAA+B,CAAC,aAAa,EAAE,EAAE,EAAE,SAAS,CAAC,EAAC;;;CACrE,CAAC"}
+{"version":3,"file":"runWithAmplifyServerContext.js","sourceRoot":"","sources":["../src/runWithAmplifyServerContext.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGtC,OAAO,EACN,+CAA+C,EAC/C,gBAAgB,GAChB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,EACN,yCAAyC,EACzC,6CAA6C,EAC7C,4BAA4B,EAC5B,2BAA2B,IAAI,+BAA+B,GAC9D,MAAM,oCAAoC,CAAC;AAE5C,MAAM,CAAC,IAAM,2BAA2B,GACvC,UAAO,EAAgC;QAA9B,iBAAiB,uBAAA,EAAE,SAAS,eAAA;;;;YAM9B,aAAa,GAAG,gBAAgB,EAAE,CAAC;YAEzC,wEAAwE;YACxE,+CAA+C;YAC/C,IAAI,aAAa,CAAC,IAAI,EAAE;gBACjB,eAAe;gBACpB,oEAAoE;gBACpE,8DAA8D;gBAC9D,iEAAiE;gBACjE,mEAAmE;gBACnE,iBAAiB,KAAK,IAAI;oBACzB,CAAC,CAAC,qBAAqB;oBACvB,CAAC,CAAC,6CAA6C,CAC7C,+CAA+C,CAAC,iBAAiB,CAAC,CACjE,CAAC;gBACA,mBAAmB,GAAG,yCAAyC,CACpE,aAAa,CAAC,IAAI,EAClB,eAAe,CACf,CAAC;gBACI,aAAa,GAAG,4BAA4B,CACjD,aAAa,CAAC,IAAI,EAClB,eAAe,CACf,CAAC;gBAEF,sBAAO,+BAA+B,CACrC,aAAa,EACb;wBACC,IAAI,EAAE,EAAE,mBAAmB,qBAAA,EAAE,aAAa,eAAA,EAAE;qBAC5C,EACD,SAAS,CACT,EAAC;aACF;YAED,oEAAoE;YACpE,+CAA+C;YAC/C,sBAAO,+BAA+B,CAAC,aAAa,EAAE,EAAE,EAAE,SAAS,CAAC,EAAC;;;CACrE,CAAC"}

package/lib-esm/utils/getAmplifyConfig.d.ts

@@ -1,2 +1,2 @@
-import { ResourcesConfig } from '@aws-amplify/core';
+import { ResourcesConfig } from 'aws-amplify';
 export declare const getAmplifyConfig: () => ResourcesConfig;

package/lib-esm/withAmplify.d.ts

@@ -1,9 +1,22 @@
-import { ResourcesConfig } from '@aws-amplify/core';
+import { ResourcesConfig } from 'aws-amplify';
 import { NextConfig } from 'next';
 /**
  * Merges the `amplifyConfig` into the `nextConfig.env`.
+ *
  * @param nextConfig The next config for a Next.js app.
- * @param amplifyConfig
+ * @param amplifyConfig The Amplify configuration.
+ *
+ *   **NOTE**: If you are using Amplify CLI to generate the `aws-exports.js`
+ *   file, you need to use {@link parseAmplifyConfig} to reformat the configuration.
+ *   E.g.
+ *   ```javascript
+ *   const { parseAmplifyConfig } = require('aws-amplify');
+ *   const { withAmplify } = require('@aws-amplify/adapter-nextjs/with-amplify');
+ *   const config = require('./src/aws-exports');
+ *
+ *   const nextConfig = {};
+ *   module.exports = withAmplify(nextConfig, parseAmplifyConfig(config));
+ *   ```
  * @returns The updated `nextConfig`.
  */
 export declare const withAmplify: (nextConfig: NextConfig, amplifyConfig: ResourcesConfig) => NextConfig;

package/lib-esm/withAmplify.js

@@ -16,14 +16,25 @@ var __assign = (this && this.__assign) || function () {
 // is not being transpiled by Next.js.
 /**
  * Merges the `amplifyConfig` into the `nextConfig.env`.
+ *
  * @param nextConfig The next config for a Next.js app.
- * @param amplifyConfig
+ * @param amplifyConfig The Amplify configuration.
+ *
+ *   **NOTE**: If you are using Amplify CLI to generate the `aws-exports.js`
+ *   file, you need to use {@link parseAmplifyConfig} to reformat the configuration.
+ *   E.g.
+ *   ```javascript
+ *   const { parseAmplifyConfig } = require('aws-amplify');
+ *   const { withAmplify } = require('@aws-amplify/adapter-nextjs/with-amplify');
+ *   const config = require('./src/aws-exports');
+ *
+ *   const nextConfig = {};
+ *   module.exports = withAmplify(nextConfig, parseAmplifyConfig(config));
+ *   ```
  * @returns The updated `nextConfig`.
  */
 export var withAmplify = function (nextConfig, amplifyConfig) {
-    nextConfig.env = __assign(__assign({}, nextConfig.env), { 
-        // TODO(Hui): follow up the validation of the amplifyConfig.
-        amplifyConfig: JSON.stringify(amplifyConfig) });
+    nextConfig.env = __assign(__assign({}, nextConfig.env), { amplifyConfig: JSON.stringify(amplifyConfig) });
     return nextConfig;
 };
 //# sourceMappingURL=withAmplify.js.map

package/lib-esm/withAmplify.js.map

@@ -1 +1 @@
-{"version":3,"file":"withAmplify.js","sourceRoot":"","sources":["../src/withAmplify.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC;;;;;;;;;;;;AAKtC,oEAAoE;AACpE,2EAA2E;AAC3E,sCAAsC;AAEtC;;;;;GAKG;AACH,MAAM,CAAC,IAAM,WAAW,GAAG,UAC1B,UAAsB,EACtB,aAA8B;IAE9B,UAAU,CAAC,GAAG,yBACV,UAAU,CAAC,GAAG;QACjB,4DAA4D;QAC5D,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,GAC5C,CAAC;IAEF,OAAO,UAAU,CAAC;AACnB,CAAC,CAAC"}
+{"version":3,"file":"withAmplify.js","sourceRoot":"","sources":["../src/withAmplify.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC;;;;;;;;;;;;AAKtC,oEAAoE;AACpE,2EAA2E;AAC3E,sCAAsC;AAEtC;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,IAAM,WAAW,GAAG,UAC1B,UAAsB,EACtB,aAA8B;IAE9B,UAAU,CAAC,GAAG,yBACV,UAAU,CAAC,GAAG,KACjB,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,GAC5C,CAAC;IAEF,OAAO,UAAU,CAAC;AACnB,CAAC,CAAC"}

package/package.json

@@ -15,7 +15,7 @@
 		"@types/node": "^20.3.1",
 		"@types/react": "^18.2.13",
 		"@types/react-dom": "^18.2.6",
-		"aws-amplify": "6.0.1-console-preview.1053355.0+1053355",
+		"aws-amplify": "6.0.1-console-preview.957cda4.0+957cda4",
 		"jest-fetch-mock": "3.0.3",
 		"next": ">= 13.4.0 < 14.0.0",
 		"typescript": "5.1.6"
@@ -107,6 +107,6 @@
 		"ts-coverage": "typescript-coverage-report -p ./tsconfig.build.json -t 90.31"
 	},
 	"typings": "./lib-esm/index.d.ts",
-	"version": "0.0.2-console-preview.1053355.0+1053355",
-	"gitHead": "1053355d0160296ba83ed4ae1b4f8cf759717f71"
+	"version": "0.0.2-console-preview.957cda4.0+957cda4",
+	"gitHead": "957cda4161ffdf663890650e52d032f64197b67a"
 }

package/src/runWithAmplifyServerContext.ts

@@ -27,12 +27,12 @@ export const runWithAmplifyServerContext: NextServer.RunOperationWithContext =
 		// context with token and credentials provider.
 		if (amplifyConfig.Auth) {
 			const keyValueStorage =
+				// When `null` is passed as the value of `nextServerContext`, opt-in
+				// unauthenticated role (primarily for static rendering). It's
+				// safe to use the singleton `MemoryKeyValueStorage` here, as the
+				// static rendering uses the same unauthenticated role cross-sever.
 				nextServerContext === null
-					? // When `null` is passed as the value of `nextServerContext`, opt-in
-					  // unauthenticated role (primarily for static rendering). It's
-					  // safe to use the singleton `MemoryKeyValueStorage` here, as the
-					  // static rendering uses the same unauthenticated role cross-sever.
-					  MemoryKeyValueStorage
+					? MemoryKeyValueStorage
 					: createKeyValueStorageFromCookieStorageAdapter(
 							createCookieStorageAdapterFromNextServerContext(nextServerContext)
 					  );

package/src/utils/getAmplifyConfig.ts

@@ -1,7 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { ResourcesConfig } from '@aws-amplify/core';
+import { ResourcesConfig } from 'aws-amplify';
 import { AmplifyServerContextError } from '@aws-amplify/core/internals/adapter-core';
 
 export const getAmplifyConfig = (): ResourcesConfig => {

package/src/withAmplify.ts

@@ -1,7 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { ResourcesConfig } from '@aws-amplify/core';
+import { ResourcesConfig, parseAmplifyConfig } from 'aws-amplify';
 import { NextConfig } from 'next';
 
 // NOTE: this function is exported from the subpath `/with-amplify`.
@@ -10,8 +10,21 @@ import { NextConfig } from 'next';
 
 /**
  * Merges the `amplifyConfig` into the `nextConfig.env`.
+ *
  * @param nextConfig The next config for a Next.js app.
- * @param amplifyConfig
+ * @param amplifyConfig The Amplify configuration.
+ *
+ *   **NOTE**: If you are using Amplify CLI to generate the `aws-exports.js`
+ *   file, you need to use {@link parseAmplifyConfig} to reformat the configuration.
+ *   E.g.
+ *   ```javascript
+ *   const { parseAmplifyConfig } = require('aws-amplify');
+ *   const { withAmplify } = require('@aws-amplify/adapter-nextjs/with-amplify');
+ *   const config = require('./src/aws-exports');
+ *
+ *   const nextConfig = {};
+ *   module.exports = withAmplify(nextConfig, parseAmplifyConfig(config));
+ *   ```
  * @returns The updated `nextConfig`.
  */
 export const withAmplify = (
@@ -20,7 +33,6 @@ export const withAmplify = (
 ) => {
 	nextConfig.env = {
 		...nextConfig.env,
-		// TODO(Hui): follow up the validation of the amplifyConfig.
 		amplifyConfig: JSON.stringify(amplifyConfig),
 	};