@aws-amplify/core 6.3.9 → 6.3.10-storage-browser.37d5283.0

package/src/parseAmplifyOutputs.ts

@@ -4,7 +4,7 @@
 /* This is because JSON schema contains keys with snake_case */
 /* eslint-disable camelcase */
 
-/* Does not like exahaustive checks */
+/* Does not like exhaustive checks */
 /* eslint-disable no-case-declarations */
 
 import {
@@ -25,11 +25,13 @@ import {
 	AmplifyOutputsDataProperties,
 	AmplifyOutputsGeoProperties,
 	AmplifyOutputsNotificationsProperties,
+	AmplifyOutputsStorageBucketProperties,
 	AmplifyOutputsStorageProperties,
 } from './singleton/AmplifyOutputs/types';
 import {
 	AnalyticsConfig,
 	AuthConfig,
+	BucketInfo,
 	GeoConfig,
 	LegacyConfig,
 	ResourcesConfig,
@@ -56,12 +58,13 @@ function parseStorage(
 		return undefined;
 	}
 
-	const { bucket_name, aws_region } = amplifyOutputsStorageProperties;
+	const { bucket_name, aws_region, buckets } = amplifyOutputsStorageProperties;
 
 	return {
 		S3: {
 			bucket: bucket_name,
 			region: aws_region,
+			buckets: buckets && createBucketInfoMap(buckets),
 		},
 	};
 }
@@ -333,3 +336,24 @@ function getMfaStatus(
 
 	return 'off';
 }
+
+function createBucketInfoMap(
+	buckets: AmplifyOutputsStorageBucketProperties[],
+): Record<string, BucketInfo> {
+	const mappedBuckets: Record<string, BucketInfo> = {};
+
+	buckets.forEach(({ name, bucket_name: bucketName, aws_region: region }) => {
+		if (name in mappedBuckets) {
+			throw new Error(
+				`Duplicate friendly name found: ${name}. Name must be unique.`,
+			);
+		}
+
+		mappedBuckets[name] = {
+			bucketName,
+			region,
+		};
+	});
+
+	return mappedBuckets;
+}

package/src/singleton/AmplifyOutputs/types.ts

@@ -43,9 +43,21 @@ export interface AmplifyOutputsAuthProperties {
 	mfa_methods?: string[];
 }
 
+export interface AmplifyOutputsStorageBucketProperties {
+	/** Friendly bucket name provided in Amplify Outputs */
+	name: string;
+	/** Actual S3 bucket name given */
+	bucket_name: string;
+	/** Region for the bucket */
+	aws_region: string;
+}
 export interface AmplifyOutputsStorageProperties {
+	/** Default region for Storage */
 	aws_region: string;
+	/** Default bucket for Storage */
 	bucket_name: string;
+	/** List of buckets for Storage */
+	buckets?: AmplifyOutputsStorageBucketProperties[];
 }
 
 export interface AmplifyOutputsGeoProperties {

package/src/singleton/Storage/types.ts

@@ -6,6 +6,13 @@ import { AtLeastOne } from '../types';
 /** @deprecated This may be removed in the next major version. */
 export type StorageAccessLevel = 'guest' | 'protected' | 'private';
 
+/** Information on bucket used to store files/objects */
+export interface BucketInfo {
+	/** Actual bucket name */
+	bucketName: string;
+	/** Region of the bucket */
+	region: string;
+}
 export interface S3ProviderConfig {
 	S3: {
 		bucket?: string;
@@ -16,6 +23,8 @@ export interface S3ProviderConfig {
 		 * @internal
 		 */
 		dangerouslyConnectToHttpEndpointForTesting?: string;
+		/** Map of friendly name for bucket to its information  */
+		buckets?: Record<string, BucketInfo>;
 	};
 }
 

package/src/singleton/types.ts

@@ -19,6 +19,7 @@ import {
 import { GeoConfig } from './Geo/types';
 import { PredictionsConfig } from './Predictions/types';
 import {
+	BucketInfo,
 	LibraryStorageOptions,
 	StorageAccessLevel,
 	StorageConfig,
@@ -77,6 +78,7 @@ export {
 	PredictionsConfig,
 	StorageAccessLevel,
 	StorageConfig,
+	BucketInfo,
 	AnalyticsConfig,
 	CognitoIdentityPoolConfig,
 	GeoConfig,