@aws-amplify/core 6.0.29-unstable.d0fdfa6.0 → 6.1.0

package/dist/esm/singleton/Storage/types.d.ts

@@ -1,4 +1,5 @@
 import { AtLeastOne } from '../types';
+/** @deprecated This may be removed in the next major version. */
 export type StorageAccessLevel = 'guest' | 'protected' | 'private';
 export interface S3ProviderConfig {
     S3: {
@@ -13,13 +14,22 @@ export interface S3ProviderConfig {
     };
 }
 export type StorageConfig = AtLeastOne<S3ProviderConfig>;
+/** @deprecated This may be removed in the next major version. */
 type StoragePrefixResolver = (params: {
     accessLevel: StorageAccessLevel;
     targetIdentityId?: string;
 }) => Promise<string>;
 export interface LibraryStorageOptions {
     S3: {
+        /**
+         * @deprecated This may be removed in the next major version.
+         * This is currently used for Storage API signature using key as input parameter.
+         * */
         prefixResolver?: StoragePrefixResolver;
+        /**
+         * @deprecated This may be removed in the next major version.
+         * This is currently used for Storage API signature using key as input parameter.
+         * */
         defaultAccessLevel?: StorageAccessLevel;
         isObjectLockEnabled?: boolean;
     };

package/dist/esm/singleton/types.d.ts

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

package/dist/esm/utils/parseAmplifyConfig.d.ts

@@ -0,0 +1,10 @@
+import { ResourcesConfig } from '../index';
+import { AmplifyOutputs } from '../singleton/AmplifyOutputs/types';
+import { LegacyConfig } from '../singleton/types';
+/**
+ * Parses the variety of configuration shapes that Amplify can accept into a ResourcesConfig.
+ *
+ * @param amplifyConfig An Amplify configuration object conforming to one of the supported schemas.
+ * @return A ResourcesConfig for the provided configuration object.
+ */
+export declare const parseAmplifyConfig: (amplifyConfig: ResourcesConfig | LegacyConfig | AmplifyOutputs) => ResourcesConfig;

package/dist/esm/utils/parseAmplifyConfig.mjs

@@ -0,0 +1,25 @@
+import { parseAWSExports } from '../parseAWSExports.mjs';
+import { isAmplifyOutputs, parseAmplifyOutputs } from '../parseAmplifyOutputs.mjs';
+
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * Parses the variety of configuration shapes that Amplify can accept into a ResourcesConfig.
+ *
+ * @param amplifyConfig An Amplify configuration object conforming to one of the supported schemas.
+ * @return A ResourcesConfig for the provided configuration object.
+ */
+const parseAmplifyConfig = (amplifyConfig) => {
+    if (Object.keys(amplifyConfig).some(key => key.startsWith('aws_'))) {
+        return parseAWSExports(amplifyConfig);
+    }
+    else if (isAmplifyOutputs(amplifyConfig)) {
+        return parseAmplifyOutputs(amplifyConfig);
+    }
+    else {
+        return amplifyConfig;
+    }
+};
+
+export { parseAmplifyConfig };
+//# sourceMappingURL=parseAmplifyConfig.mjs.map

package/dist/esm/utils/parseAmplifyConfig.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseAmplifyConfig.mjs","sources":["../../../src/utils/parseAmplifyConfig.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { parseAWSExports } from '../parseAWSExports';\nimport { isAmplifyOutputs, parseAmplifyOutputs } from '../parseAmplifyOutputs';\n/**\n * Parses the variety of configuration shapes that Amplify can accept into a ResourcesConfig.\n *\n * @param amplifyConfig An Amplify configuration object conforming to one of the supported schemas.\n * @return A ResourcesConfig for the provided configuration object.\n */\nexport const parseAmplifyConfig = (amplifyConfig) => {\n    if (Object.keys(amplifyConfig).some(key => key.startsWith('aws_'))) {\n        return parseAWSExports(amplifyConfig);\n    }\n    else if (isAmplifyOutputs(amplifyConfig)) {\n        return parseAmplifyOutputs(amplifyConfig);\n    }\n    else {\n        return amplifyConfig;\n    }\n};\n"],"names":[],"mappings":";;;AAAA;AACA;AAGA;AACA;AACA;AACA;AACA;AACA;AACY,MAAC,kBAAkB,GAAG,CAAC,aAAa,KAAK;AACrD,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE;AACxE,QAAQ,OAAO,eAAe,CAAC,aAAa,CAAC,CAAC;AAC9C,KAAK;AACL,SAAS,IAAI,gBAAgB,CAAC,aAAa,CAAC,EAAE;AAC9C,QAAQ,OAAO,mBAAmB,CAAC,aAAa,CAAC,CAAC;AAClD,KAAK;AACL,SAAS;AACT,QAAQ,OAAO,aAAa,CAAC;AAC7B,KAAK;AACL;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@aws-amplify/core",
-	"version": "6.0.29-unstable.d0fdfa6.0+d0fdfa6",
+	"version": "6.1.0",
 	"description": "Core category of aws-amplify",
 	"main": "./dist/cjs/index.js",
 	"module": "./dist/esm/index.mjs",
@@ -60,7 +60,7 @@
 		"uuid": "^9.0.0"
 	},
 	"devDependencies": {
-		"@aws-amplify/react-native": "1.0.29-unstable.d0fdfa6.0+d0fdfa6",
+		"@aws-amplify/react-native": "1.0.28",
 		"@types/js-cookie": "3.0.2",
 		"genversion": "^2.2.0",
 		"typescript": "5.0.2"
@@ -192,5 +192,5 @@
 			]
 		}
 	},
-	"gitHead": "d0fdfa6f3ff566d0986ff1301e941f0034cd06b1"
+	"gitHead": "0cc3ea9027fdb5d35b3c32e183555c51652da62f"
 }

package/src/Platform/version.ts

@@ -1,2 +1,2 @@
 // generated by genversion
-export const version = '6.1.4-unstable.d0fdfa6.0+d0fdfa6';
+export const version = '6.2.0';

package/src/libraryUtils.ts

@@ -21,11 +21,15 @@ export {
 	deDupeAsyncFunction,
 } from './utils';
 export { parseAWSExports } from './parseAWSExports';
+export { isAmplifyOutputs, parseAmplifyOutputs } from './parseAmplifyOutputs';
 export { LegacyConfig } from './singleton/types';
+export { AmplifyOutputs } from './singleton/AmplifyOutputs/types';
 export { ADD_OAUTH_LISTENER } from './singleton/constants';
 export { amplifyUuid } from './utils/amplifyUuid';
 export { AmplifyUrl, AmplifyUrlSearchParams } from './utils/amplifyUrl';
+export { parseAmplifyConfig } from './utils/parseAmplifyConfig';
 export { getClientInfo } from './utils';
+
 // Auth utilities
 export {
 	decodeJWT,

package/src/parseAWSExports.ts

@@ -249,15 +249,14 @@ export const parseAWSExports = (
 	// Geo
 	if (geo) {
 		const { amazon_location_service } = geo;
-		(amplifyConfig as any).Geo = amazon_location_service
-			? {
-					LocationService: {
-						...amazon_location_service,
-						searchIndices: amazon_location_service.search_indices,
-						region: amazon_location_service.region,
-					},
-				}
-			: { ...geo };
+		amplifyConfig.Geo = {
+			LocationService: {
+				maps: amazon_location_service.maps,
+				geofenceCollections: amazon_location_service.geofenceCollections,
+				searchIndices: amazon_location_service.search_indices,
+				region: amazon_location_service.region,
+			},
+		};
 	}
 
 	// REST API

package/src/parseAmplifyOutputs.ts

@@ -0,0 +1,333 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+/* This is because JSON schema contains keys with snake_case */
+/* eslint-disable camelcase */
+
+/* Does not like exahaustive checks */
+/* eslint-disable no-case-declarations */
+
+import {
+	APIConfig,
+	APIGraphQLConfig,
+	GraphQLAuthMode,
+	ModelIntrospectionSchema,
+} from './singleton/API/types';
+import {
+	CognitoUserPoolConfigMfaStatus,
+	OAuthProvider,
+} from './singleton/Auth/types';
+import { NotificationsConfig } from './singleton/Notifications/types';
+import {
+	AmplifyOutputs,
+	AmplifyOutputsAnalyticsProperties,
+	AmplifyOutputsAuthProperties,
+	AmplifyOutputsDataProperties,
+	AmplifyOutputsGeoProperties,
+	AmplifyOutputsNotificationsProperties,
+	AmplifyOutputsStorageProperties,
+} from './singleton/AmplifyOutputs/types';
+import {
+	AnalyticsConfig,
+	AuthConfig,
+	GeoConfig,
+	LegacyConfig,
+	ResourcesConfig,
+	StorageConfig,
+} from './singleton/types';
+
+export function isAmplifyOutputs(
+	config: ResourcesConfig | LegacyConfig | AmplifyOutputs,
+): config is AmplifyOutputs {
+	// 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;
+
+	if (!version) {
+		return false;
+	}
+
+	return version.startsWith('1');
+}
+
+function parseStorage(
+	amplifyOutputsStorageProperties?: AmplifyOutputsStorageProperties,
+): StorageConfig | undefined {
+	if (!amplifyOutputsStorageProperties) {
+		return undefined;
+	}
+
+	const { bucket_name, aws_region } = amplifyOutputsStorageProperties;
+
+	return {
+		S3: {
+			bucket: bucket_name,
+			region: aws_region,
+		},
+	};
+}
+
+function parseAuth(
+	amplifyOutputsAuthProperties?: AmplifyOutputsAuthProperties,
+): AuthConfig | undefined {
+	if (!amplifyOutputsAuthProperties) {
+		return undefined;
+	}
+
+	const {
+		user_pool_id,
+		user_pool_client_id,
+		identity_pool_id,
+		password_policy,
+		mfa_configuration,
+		mfa_methods,
+		unauthenticated_identities_enabled,
+		oauth,
+		username_attributes,
+		standard_required_attributes,
+	} = amplifyOutputsAuthProperties;
+
+	const authConfig = {
+		Cognito: {
+			userPoolId: user_pool_id,
+			userPoolClientId: user_pool_client_id,
+		},
+	} as AuthConfig;
+
+	if (identity_pool_id) {
+		authConfig.Cognito = {
+			...authConfig.Cognito,
+			identityPoolId: identity_pool_id,
+		};
+	}
+
+	if (password_policy) {
+		authConfig.Cognito.passwordFormat = {
+			requireLowercase: password_policy.require_lowercase,
+			requireNumbers: password_policy.require_numbers,
+			requireUppercase: password_policy.require_uppercase,
+			requireSpecialCharacters: password_policy.require_symbols,
+			minLength: password_policy.min_length ?? 6,
+		};
+	}
+
+	if (mfa_configuration) {
+		authConfig.Cognito.mfa = {
+			status: getMfaStatus(mfa_configuration),
+			smsEnabled: mfa_methods?.includes('SMS'),
+			totpEnabled: mfa_methods?.includes('TOTP'),
+		};
+	}
+
+	if (unauthenticated_identities_enabled) {
+		authConfig.Cognito.allowGuestAccess = unauthenticated_identities_enabled;
+	}
+
+	if (oauth) {
+		authConfig.Cognito.loginWith = {
+			oauth: {
+				domain: oauth.domain,
+				redirectSignIn: oauth.redirect_sign_in_uri,
+				redirectSignOut: oauth.redirect_sign_out_uri,
+				responseType: oauth.response_type === 'token' ? 'token' : 'code',
+				scopes: oauth.scopes,
+				providers: getOAuthProviders(oauth.identity_providers),
+			},
+		};
+	}
+
+	if (username_attributes?.includes('email')) {
+		authConfig.Cognito.loginWith = {
+			...authConfig.Cognito.loginWith,
+			email: true,
+		};
+	}
+
+	if (username_attributes?.includes('phone_number')) {
+		authConfig.Cognito.loginWith = {
+			...authConfig.Cognito.loginWith,
+			phone: true,
+		};
+	}
+
+	if (standard_required_attributes) {
+		authConfig.Cognito.userAttributes = standard_required_attributes.reduce(
+			(acc, curr) => ({ ...acc, [curr]: { required: true } }),
+			{},
+		);
+	}
+
+	return authConfig;
+}
+
+export function parseAnalytics(
+	amplifyOutputsAnalyticsProperties?: AmplifyOutputsAnalyticsProperties,
+): AnalyticsConfig | undefined {
+	if (!amplifyOutputsAnalyticsProperties?.amazon_pinpoint) {
+		return undefined;
+	}
+
+	const { amazon_pinpoint } = amplifyOutputsAnalyticsProperties;
+
+	return {
+		Pinpoint: {
+			appId: amazon_pinpoint.app_id,
+			region: amazon_pinpoint.aws_region,
+		},
+	};
+}
+
+function parseGeo(
+	amplifyOutputsAnalyticsProperties?: AmplifyOutputsGeoProperties,
+): GeoConfig | undefined {
+	if (!amplifyOutputsAnalyticsProperties) {
+		return undefined;
+	}
+
+	const { aws_region, geofence_collections, maps, search_indices } =
+		amplifyOutputsAnalyticsProperties;
+
+	return {
+		LocationService: {
+			region: aws_region,
+			searchIndices: search_indices,
+			geofenceCollections: geofence_collections,
+			maps,
+		},
+	};
+}
+
+function parseData(
+	amplifyOutputsDataProperties?: AmplifyOutputsDataProperties,
+): APIConfig | undefined {
+	if (!amplifyOutputsDataProperties) {
+		return undefined;
+	}
+
+	const {
+		aws_region,
+		default_authorization_type,
+		url,
+		api_key,
+		model_introspection,
+	} = amplifyOutputsDataProperties;
+
+	const GraphQL: APIGraphQLConfig = {
+		endpoint: url,
+		defaultAuthMode: getGraphQLAuthMode(default_authorization_type),
+		region: aws_region,
+		apiKey: api_key,
+		modelIntrospection: model_introspection as ModelIntrospectionSchema,
+	};
+
+	return {
+		GraphQL,
+	};
+}
+
+function parseNotifications(
+	amplifyOutputsNotificationsProperties?: AmplifyOutputsNotificationsProperties,
+): NotificationsConfig | undefined {
+	if (!amplifyOutputsNotificationsProperties) {
+		return undefined;
+	}
+
+	const { aws_region, channels, amazon_pinpoint_app_id } =
+		amplifyOutputsNotificationsProperties;
+
+	const hasInAppMessaging = channels.includes('IN_APP_MESSAGING');
+	const hasPushNotification =
+		channels.includes('APNS') || channels.includes('FCM');
+
+	if (!(hasInAppMessaging || hasPushNotification)) {
+		return undefined;
+	}
+
+	// At this point, we know the Amplify outputs contains at least one supported channel
+	const notificationsConfig: NotificationsConfig = {} as NotificationsConfig;
+
+	if (hasInAppMessaging) {
+		notificationsConfig.InAppMessaging = {
+			Pinpoint: {
+				appId: amazon_pinpoint_app_id,
+				region: aws_region,
+			},
+		};
+	}
+
+	if (hasPushNotification) {
+		notificationsConfig.PushNotification = {
+			Pinpoint: {
+				appId: amazon_pinpoint_app_id,
+				region: aws_region,
+			},
+		};
+	}
+
+	return notificationsConfig;
+}
+
+export function parseAmplifyOutputs(
+	amplifyOutputs: AmplifyOutputs,
+): ResourcesConfig {
+	const resourcesConfig: ResourcesConfig = {};
+
+	if (amplifyOutputs.storage) {
+		resourcesConfig.Storage = parseStorage(amplifyOutputs.storage);
+	}
+
+	if (amplifyOutputs.auth) {
+		resourcesConfig.Auth = parseAuth(amplifyOutputs.auth);
+	}
+
+	if (amplifyOutputs.analytics) {
+		resourcesConfig.Analytics = parseAnalytics(amplifyOutputs.analytics);
+	}
+
+	if (amplifyOutputs.geo) {
+		resourcesConfig.Geo = parseGeo(amplifyOutputs.geo);
+	}
+
+	if (amplifyOutputs.data) {
+		resourcesConfig.API = parseData(amplifyOutputs.data);
+	}
+
+	if (amplifyOutputs.notifications) {
+		resourcesConfig.Notifications = parseNotifications(
+			amplifyOutputs.notifications,
+		);
+	}
+
+	return resourcesConfig;
+}
+
+const authModeNames: Record<string, GraphQLAuthMode> = {
+	AMAZON_COGNITO_USER_POOLS: 'userPool',
+	API_KEY: 'apiKey',
+	AWS_IAM: 'iam',
+	AWS_LAMBDA: 'lambda',
+	OPENID_CONNECT: 'oidc',
+};
+
+function getGraphQLAuthMode(authType: string): GraphQLAuthMode {
+	return authModeNames[authType];
+}
+
+const providerNames: Record<string, OAuthProvider> = {
+	GOOGLE: 'Google',
+	LOGIN_WITH_AMAZON: 'Amazon',
+	FACEBOOK: 'Facebook',
+	SIGN_IN_WITH_APPLE: 'Apple',
+};
+
+function getOAuthProviders(providers: string[] = []): OAuthProvider[] {
+	return providers.map(provider => providerNames[provider]);
+}
+
+function getMfaStatus(
+	mfaConfiguration: string,
+): CognitoUserPoolConfigMfaStatus {
+	if (mfaConfiguration === 'OPTIONAL') return 'optional';
+	if (mfaConfiguration === 'REQUIRED') return 'on';
+
+	return 'off';
+}

package/src/singleton/API/types.ts

@@ -18,7 +18,7 @@ export interface LibraryAPIOptions {
 	};
 }
 
-interface APIGraphQLConfig {
+export interface APIGraphQLConfig {
 	/**
 	 * Required GraphQL endpoint, must be a valid URL string.
 	 */
@@ -47,7 +47,7 @@ interface APIGraphQLConfig {
 	modelIntrospection?: ModelIntrospectionSchema;
 }
 
-interface APIRestConfig {
+export interface APIRestConfig {
 	/**
 	 * Required REST endpoint, must be a valid URL string.
 	 */
@@ -81,7 +81,9 @@ export type GraphQLAuthMode =
 	| 'apiKey'
 	| 'oidc'
 	| 'userPool'
+	// @deprecated; use 'identityPool'
 	| 'iam'
+	| 'identityPool'
 	| 'lambda'
 	| 'none';
 

package/src/singleton/Amplify.ts

@@ -1,10 +1,11 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import { AMPLIFY_SYMBOL, Hub } from '../Hub';
-import { parseAWSExports } from '../parseAWSExports';
 import { deepFreeze } from '../utils';
+import { parseAmplifyConfig } from '../libraryUtils';
 
 import {
+	AmplifyOutputs,
 	AuthConfig,
 	LegacyConfig,
 	LibraryOptions,
@@ -48,16 +49,10 @@ export class AmplifyClass {
 	 * @param libraryOptions - Additional options for customizing the behavior of the library.
 	 */
 	configure(
-		resourcesConfig: ResourcesConfig | LegacyConfig,
+		resourcesConfig: ResourcesConfig | LegacyConfig | AmplifyOutputs,
 		libraryOptions?: LibraryOptions,
 	): void {
-		let resolvedResourceConfig: ResourcesConfig;
-
-		if (Object.keys(resourcesConfig).some(key => key.startsWith('aws_'))) {
-			resolvedResourceConfig = parseAWSExports(resourcesConfig);
-		} else {
-			resolvedResourceConfig = resourcesConfig as ResourcesConfig;
-		}
+		const resolvedResourceConfig = parseAmplifyConfig(resourcesConfig);
 
 		this.resourcesConfig = resolvedResourceConfig;
 

package/src/singleton/AmplifyOutputs/types.ts

@@ -0,0 +1,99 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export type AmplifyOutputsOAuthIdentityProvider =
+	| 'GOOGLE'
+	| 'FACEBOOK'
+	| 'LOGIN_WITH_AMAZON'
+	| 'SIGN_IN_WITH_APPLE';
+
+export type AmplifyOutputsAuthMFAConfiguration =
+	| 'OPTIONAL'
+	| 'REQUIRED'
+	| 'NONE';
+
+export type AmplifyOutputsAuthMFAMethod = 'SMS' | 'TOTP';
+
+export interface AmplifyOutputsAuthProperties {
+	aws_region: string;
+	authentication_flow_type?: 'USER_SRP_AUTH' | 'CUSTOM_AUTH';
+	user_pool_id: string;
+	user_pool_client_id: string;
+	identity_pool_id?: string;
+	password_policy?: {
+		min_length: number;
+		require_numbers: boolean;
+		require_lowercase: boolean;
+		require_uppercase: boolean;
+		require_symbols: boolean;
+	};
+	oauth?: {
+		identity_providers: string[];
+		domain: string;
+		scopes: string[];
+		redirect_sign_in_uri: string[];
+		redirect_sign_out_uri: string[];
+		response_type: string;
+	};
+	standard_required_attributes?: string[];
+	username_attributes?: string[];
+	user_verification_types?: string[];
+	unauthenticated_identities_enabled?: boolean;
+	mfa_configuration?: string;
+	mfa_methods?: string[];
+}
+
+export interface AmplifyOutputsStorageProperties {
+	aws_region: string;
+	bucket_name: string;
+}
+
+export interface AmplifyOutputsGeoProperties {
+	aws_region: string;
+	maps?: {
+		items: Record<string, unknown>;
+		default: string;
+	};
+	search_indices?: { items: string[]; default: string };
+	geofence_collections?: { items: string[]; default: string };
+}
+
+export interface AmplifyOutputsAnalyticsProperties {
+	amazon_pinpoint?: {
+		aws_region: string;
+		app_id: string;
+	};
+}
+
+export type AuthType =
+	| 'AMAZON_COGNITO_USER_POOLS'
+	| 'API_KEY'
+	| 'AWS_IAM'
+	| 'AWS_LAMBDA'
+	| 'OPENID_CONNECT';
+
+export interface AmplifyOutputsDataProperties {
+	aws_region: string;
+	url: string;
+	default_authorization_type: string;
+	authorization_types: string[];
+	model_introspection?: object;
+	api_key?: string;
+	conflict_resolution_mode?: string;
+}
+
+export interface AmplifyOutputsNotificationsProperties {
+	aws_region: string;
+	amazon_pinpoint_app_id: string;
+	channels: string[];
+}
+
+export interface AmplifyOutputs {
+	version?: string;
+	storage?: AmplifyOutputsStorageProperties;
+	auth?: AmplifyOutputsAuthProperties;
+	analytics?: AmplifyOutputsAnalyticsProperties;
+	geo?: AmplifyOutputsGeoProperties;
+	data?: AmplifyOutputsDataProperties;
+	notifications?: AmplifyOutputsNotificationsProperties;
+}

package/src/singleton/Auth/types.ts

@@ -145,6 +145,8 @@ export interface AuthUserPoolConfig {
 	};
 }
 
+export type CognitoUserPoolConfigMfaStatus = 'on' | 'off' | 'optional';
+
 export interface CognitoUserPoolConfig {
 	userPoolClientId: string;
 	userPoolId: string;
@@ -158,7 +160,7 @@ export interface CognitoUserPoolConfig {
 	};
 	userAttributes?: AuthConfigUserAttributes;
 	mfa?: {
-		status?: 'on' | 'off' | 'optional';
+		status?: CognitoUserPoolConfigMfaStatus;
 		totpEnabled?: boolean;
 		smsEnabled?: boolean;
 	};

package/src/singleton/Storage/types.ts

@@ -3,6 +3,7 @@
 
 import { AtLeastOne } from '../types';
 
+/** @deprecated This may be removed in the next major version. */
 export type StorageAccessLevel = 'guest' | 'protected' | 'private';
 
 export interface S3ProviderConfig {
@@ -20,6 +21,7 @@ export interface S3ProviderConfig {
 
 export type StorageConfig = AtLeastOne<S3ProviderConfig>;
 
+/** @deprecated This may be removed in the next major version. */
 type StoragePrefixResolver = (params: {
 	accessLevel: StorageAccessLevel;
 	targetIdentityId?: string;
@@ -27,7 +29,15 @@ type StoragePrefixResolver = (params: {
 
 export interface LibraryStorageOptions {
 	S3: {
+		/**
+		 * @deprecated This may be removed in the next major version.
+		 * This is currently used for Storage API signature using key as input parameter.
+		 * */
 		prefixResolver?: StoragePrefixResolver;
+		/**
+		 * @deprecated This may be removed in the next major version.
+		 * This is currently used for Storage API signature using key as input parameter.
+		 * */
 		defaultAccessLevel?: StorageAccessLevel;
 		isObjectLockEnabled?: boolean;
 	};