fix(core): make AmplifyOutputs category types as unknown (#14153)

* fix(core): make AmplifyOutputs category types as unknown

* chore: remove previously added path parsing logic for AmplifyOutputs

* chore: remove previously added Partial on AmplifyOutputs

* add adapter-core internals subpath

* change AmplifyOutputs deprecation message wording

* add type casting for categories with mandatory properties

* fix linter issues

* add back parsing logic to remove undefined paths

---------

Co-authored-by: Ashwin Kumar <[email protected]>

Author: ashwinkumar6

packages/adapter-nextjs/src/types/NextServer.ts

@@ -4,10 +4,11 @@
 import { GetServerSidePropsContext as NextGetServerSidePropsContext } from 'next';
 import { NextRequest, NextResponse } from 'next/server.js';
 import { cookies } from 'next/headers.js';
-import { AmplifyOutputs, LegacyConfig } from 'aws-amplify/adapter-core';
 import {
+	AmplifyOutputsUnknown,
 	AmplifyServer,
 	CookieStorage,
+	LegacyConfig,
 } from 'aws-amplify/adapter-core/internals';
 import { ResourcesConfig } from 'aws-amplify';
 
@@ -86,7 +87,7 @@ export declare namespace NextServer {
 	}
 
 	export interface CreateServerRunnerInput {
-		config: ResourcesConfig | LegacyConfig | AmplifyOutputs;
+		config: ResourcesConfig | LegacyConfig | AmplifyOutputsUnknown;
 		runtimeOptions?: CreateServerRunnerRuntimeOptions;
 	}
 

packages/aws-amplify/src/adapter-core/index.ts

@@ -8,7 +8,9 @@ export {
 	createUserPoolsTokenProvider,
 } from './authProvidersFactories/cognito';
 export {
+	/** @deprecated This type is deprecated and will be removed in future versions. */
 	LegacyConfig,
+	/** @deprecated This type is deprecated and will be removed in future versions. */
 	AmplifyOutputs,
 } from '@aws-amplify/core/internals/utils';
 export {

packages/aws-amplify/src/adapter-core/internals.ts

@@ -14,4 +14,6 @@ export {
 	assertTokenProviderConfig,
 	urlSafeEncode,
 	decodeJWT,
+	LegacyConfig,
+	AmplifyOutputsUnknown,
 } from '@aws-amplify/core/internals/utils';

packages/aws-amplify/src/initSingleton.ts

@@ -8,7 +8,7 @@ import {
 	defaultStorage,
 } from '@aws-amplify/core';
 import {
-	AmplifyOutputs,
+	AmplifyOutputsUnknown,
 	LegacyConfig,
 	parseAmplifyConfig,
 } from '@aws-amplify/core/internals/utils';
@@ -32,7 +32,7 @@ export const DefaultAmplify = {
 	 * Amplify.configure(config);
 	 */
 	configure(
-		resourceConfig: ResourcesConfig | LegacyConfig | AmplifyOutputs,
+		resourceConfig: ResourcesConfig | LegacyConfig | AmplifyOutputsUnknown,
 		libraryOptions?: LibraryOptions,
 	): void {
 		const resolvedResourceConfig = parseAmplifyConfig(resourceConfig);

packages/core/src/libraryUtils.ts

@@ -24,7 +24,10 @@ export {
 export { parseAWSExports } from './parseAWSExports';
 export { isAmplifyOutputs, parseAmplifyOutputs } from './parseAmplifyOutputs';
 export { LegacyConfig } from './singleton/types';
-export { AmplifyOutputs } from './singleton/AmplifyOutputs/types';
+export {
+	AmplifyOutputs,
+	AmplifyOutputsUnknown,
+} from './singleton/AmplifyOutputs/types';
 export { ADD_OAUTH_LISTENER } from './singleton/constants';
 export { amplifyUuid } from './utils/amplifyUuid';
 export { AmplifyUrl, AmplifyUrlSearchParams } from './utils/amplifyUrl';

packages/core/src/parseAmplifyOutputs.ts

@@ -19,7 +19,6 @@ import {
 } from './singleton/Auth/types';
 import { NotificationsConfig } from './singleton/Notifications/types';
 import {
-	AmplifyOutputs,
 	AmplifyOutputsAnalyticsProperties,
 	AmplifyOutputsAuthProperties,
 	AmplifyOutputsCustomProperties,
@@ -28,6 +27,7 @@ import {
 	AmplifyOutputsNotificationsProperties,
 	AmplifyOutputsStorageBucketProperties,
 	AmplifyOutputsStorageProperties,
+	AmplifyOutputsUnknown,
 } from './singleton/AmplifyOutputs/types';
 import {
 	AnalyticsConfig,
@@ -40,10 +40,10 @@ import {
 } from './singleton/types';
 
 export function isAmplifyOutputs(
-	config: ResourcesConfig | LegacyConfig | AmplifyOutputs,
-): config is AmplifyOutputs {
+	config: ResourcesConfig | LegacyConfig | AmplifyOutputsUnknown,
+): config is AmplifyOutputsUnknown {
 	// version format initially will be '1' but is expected to be something like x.y where x is major and y minor version
-	const { version } = config as AmplifyOutputs;
+	const { version } = config as AmplifyOutputsUnknown;
 
 	if (!version) {
 		return false;
@@ -291,28 +291,36 @@ function parseNotifications(
 }
 
 export function parseAmplifyOutputs(
-	amplifyOutputs: AmplifyOutputs,
+	amplifyOutputs: AmplifyOutputsUnknown,
 ): ResourcesConfig {
 	const resourcesConfig: ResourcesConfig = {};
 
 	if (amplifyOutputs.storage) {
-		resourcesConfig.Storage = parseStorage(amplifyOutputs.storage);
+		resourcesConfig.Storage = parseStorage(
+			amplifyOutputs.storage as AmplifyOutputsStorageProperties,
+		);
 	}
 
 	if (amplifyOutputs.auth) {
-		resourcesConfig.Auth = parseAuth(amplifyOutputs.auth);
+		resourcesConfig.Auth = parseAuth(
+			amplifyOutputs.auth as AmplifyOutputsAuthProperties,
+		);
 	}
 
 	if (amplifyOutputs.analytics) {
 		resourcesConfig.Analytics = parseAnalytics(amplifyOutputs.analytics);
 	}
 
 	if (amplifyOutputs.geo) {
-		resourcesConfig.Geo = parseGeo(amplifyOutputs.geo);
+		resourcesConfig.Geo = parseGeo(
+			amplifyOutputs.geo as AmplifyOutputsGeoProperties,
+		);
 	}
 
 	if (amplifyOutputs.data) {
-		resourcesConfig.API = parseData(amplifyOutputs.data);
+		resourcesConfig.API = parseData(
+			amplifyOutputs.data as AmplifyOutputsDataProperties,
+		);
 	}
 
 	if (amplifyOutputs.custom) {
@@ -325,7 +333,7 @@ export function parseAmplifyOutputs(
 
 	if (amplifyOutputs.notifications) {
 		resourcesConfig.Notifications = parseNotifications(
-			amplifyOutputs.notifications,
+			amplifyOutputs.notifications as AmplifyOutputsNotificationsProperties,
 		);
 	}
 

packages/core/src/singleton/Amplify.ts

@@ -5,7 +5,7 @@ import { deepFreeze } from '../utils';
 import { parseAmplifyConfig } from '../libraryUtils';
 
 import {
-	AmplifyOutputs,
+	AmplifyOutputsUnknown,
 	AuthConfig,
 	LegacyConfig,
 	LibraryOptions,
@@ -49,7 +49,7 @@ export class AmplifyClass {
 	 * @param libraryOptions - Additional options for customizing the behavior of the library.
 	 */
 	configure(
-		resourcesConfig: ResourcesConfig | LegacyConfig | AmplifyOutputs,
+		resourcesConfig: ResourcesConfig | LegacyConfig | AmplifyOutputsUnknown,
 		libraryOptions?: LibraryOptions,
 	): void {
 		const resolvedResourceConfig = parseAmplifyConfig(resourcesConfig);

packages/core/src/singleton/AmplifyOutputs/types.ts

@@ -42,7 +42,7 @@ export interface AmplifyOutputsAuthProperties {
 	unauthenticated_identities_enabled?: boolean;
 	mfa_configuration?: string;
 	mfa_methods?: string[];
-	groups?: Partial<Record<UserGroupName, UserGroupPrecedence>>[];
+	groups?: Record<UserGroupName, UserGroupPrecedence>[];
 }
 
 export interface AmplifyOutputsStorageBucketProperties {
@@ -53,7 +53,7 @@ export interface AmplifyOutputsStorageBucketProperties {
 	/** Region for the bucket */
 	aws_region: string;
 	/** Paths to object with access permissions */
-	paths?: Partial<Record<string, Record<string, string[] | undefined>>>;
+	paths?: Record<string, Record<string, string[] | undefined>>;
 }
 export interface AmplifyOutputsStorageProperties {
 	/** Default region for Storage */
@@ -115,6 +115,7 @@ export interface AmplifyOutputsNotificationsProperties {
 	channels: string[];
 }
 
+/** @deprecated This type is deprecated and will be removed in future versions. */
 export interface AmplifyOutputs {
 	version?: string;
 	storage?: AmplifyOutputsStorageProperties;
@@ -125,3 +126,14 @@ export interface AmplifyOutputs {
 	custom?: AmplifyOutputsCustomProperties;
 	notifications?: AmplifyOutputsNotificationsProperties;
 }
+
+export interface AmplifyOutputsUnknown {
+	version?: string;
+	storage?: unknown;
+	auth?: unknown;
+	analytics?: unknown;
+	geo?: unknown;
+	data?: unknown;
+	custom?: unknown;
+	notifications?: unknown;
+}

packages/core/src/singleton/types.ts

@@ -27,7 +27,7 @@ import {
 import { NotificationsConfig } from './Notifications/types';
 import { InteractionsConfig } from './Interactions/types';
 
-export { AmplifyOutputs } from './AmplifyOutputs/types';
+export { AmplifyOutputsUnknown } from './AmplifyOutputs/types';
 
 /**
  * Compatibility type representing the Amplify Gen 1 configuration file schema. This type should not be used directly.

packages/core/src/utils/parseAmplifyConfig.ts

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { ResourcesConfig } from '../index';
-import { AmplifyOutputs } from '../singleton/AmplifyOutputs/types';
+import { AmplifyOutputsUnknown } from '../singleton/AmplifyOutputs/types';
 import { LegacyConfig } from '../singleton/types';
 import { parseAWSExports } from '../parseAWSExports';
 import { isAmplifyOutputs, parseAmplifyOutputs } from '../parseAmplifyOutputs';
@@ -14,7 +14,7 @@ import { isAmplifyOutputs, parseAmplifyOutputs } from '../parseAmplifyOutputs';
  * @return A ResourcesConfig for the provided configuration object.
  */
 export const parseAmplifyConfig = (
-	amplifyConfig: ResourcesConfig | LegacyConfig | AmplifyOutputs,
+	amplifyConfig: ResourcesConfig | LegacyConfig | AmplifyOutputsUnknown,
 ): ResourcesConfig => {
 	if (Object.keys(amplifyConfig).some(key => key.startsWith('aws_'))) {
 		return parseAWSExports(amplifyConfig);