@aws-amplify/storage 6.6.0 → 6.6.1-storage-browser.37d5283.0

package/src/providers/s3/apis/uploadData/putObjectJob.ts

@@ -11,11 +11,14 @@ import {
 	validateStorageOperationInput,
 } from '../../utils';
 import { ItemWithKey, ItemWithPath } from '../../types/outputs';
-import { putObject } from '../../utils/client';
+import { putObject } from '../../utils/client/s3data';
 import { getStorageUserAgentValue } from '../../utils/userAgent';
 import { STORAGE_INPUT_KEY } from '../../utils/constants';
+import { calculateContentCRC32 } from '../../utils/crc32';
 import { constructContentDisposition } from '../../utils/constructContentDisposition';
 
+import { validateObjectNotExists } from './validateObjectNotExists';
+
 /**
  * Get a function the returns a promise to call putObject API to S3.
  *
@@ -30,7 +33,7 @@ export const putObjectJob =
 	async (): Promise<ItemWithKey | ItemWithPath> => {
 		const { options: uploadDataOptions, data } = uploadDataInput;
 		const { bucket, keyPrefix, s3Config, isObjectLockEnabled, identityId } =
-			await resolveS3ConfigAndInput(Amplify, uploadDataOptions);
+			await resolveS3ConfigAndInput(Amplify, uploadDataInput);
 		const { inputType, objectKey } = validateStorageOperationInput(
 			uploadDataInput,
 			identityId,
@@ -42,10 +45,25 @@ export const putObjectJob =
 			contentDisposition,
 			contentEncoding,
 			contentType = 'application/octet-stream',
+			preventOverwrite,
 			metadata,
 			onProgress,
 		} = uploadDataOptions ?? {};
 
+		const checksumCRC32 = await calculateContentCRC32(data);
+		const contentMD5 =
+			// check if checksum exists. ex: should not exist in react native
+			!checksumCRC32 && isObjectLockEnabled
+				? await calculateContentMd5(data)
+				: undefined;
+
+		if (preventOverwrite) {
+			await validateObjectNotExists(s3Config, {
+				Bucket: bucket,
+				Key: finalKey,
+			});
+		}
+
 		const { ETag: eTag, VersionId: versionId } = await putObject(
 			{
 				...s3Config,
@@ -61,9 +79,8 @@ export const putObjectJob =
 				ContentDisposition: constructContentDisposition(contentDisposition),
 				ContentEncoding: contentEncoding,
 				Metadata: metadata,
-				ContentMD5: isObjectLockEnabled
-					? await calculateContentMd5(data)
-					: undefined,
+				ContentMD5: contentMD5,
+				ChecksumCRC32: checksumCRC32?.checksum,
 			},
 		);
 

package/src/providers/s3/apis/uploadData/validateObjectNotExists.ts

@@ -0,0 +1,25 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { StorageError } from '../../../../errors/StorageError';
+import { ResolvedS3Config } from '../../types/options';
+import { HeadObjectInput, headObject } from '../../utils/client/s3data';
+
+export const validateObjectNotExists = async (
+	s3Config: ResolvedS3Config,
+	input: HeadObjectInput,
+): Promise<void> => {
+	try {
+		await headObject(s3Config, input);
+
+		throw new StorageError({
+			name: 'PreconditionFailed',
+			message: 'At least one of the pre-conditions you specified did not hold',
+		});
+	} catch (error) {
+		const serviceError = error as StorageError;
+		if (serviceError.name !== 'NotFound') {
+			throw error;
+		}
+	}
+};

package/src/providers/s3/types/index.ts

@@ -17,6 +17,8 @@ export {
 	DownloadDataOptionsWithKey,
 	CopyDestinationOptionsWithKey,
 	CopySourceOptionsWithKey,
+	CopyWithPathSourceOptions,
+	CopyWithPathDestinationOptions,
 } from './options';
 export {
 	UploadDataOutput,

package/src/providers/s3/types/inputs.ts

@@ -20,6 +20,8 @@ import {
 import {
 	CopyDestinationOptionsWithKey,
 	CopySourceOptionsWithKey,
+	CopyWithPathDestinationOptions,
+	CopyWithPathSourceOptions,
 	DownloadDataOptionsWithKey,
 	DownloadDataOptionsWithPath,
 	GetPropertiesOptionsWithKey,
@@ -35,6 +37,8 @@ import {
 	UploadDataOptionsWithPath,
 } from '../types';
 
+import { LocationCredentialsProvider } from './options';
+
 // TODO: support use accelerate endpoint option
 /**
  * @deprecated Use {@link CopyWithPathInput} instead.
@@ -47,7 +51,13 @@ export type CopyInput = StorageCopyInputWithKey<
 /**
  * Input type with path for S3 copy API.
  */
-export type CopyWithPathInput = StorageCopyInputWithPath;
+export type CopyWithPathInput = StorageCopyInputWithPath<
+	CopyWithPathSourceOptions,
+	CopyWithPathDestinationOptions,
+	{
+		locationCredentialsProvider?: LocationCredentialsProvider;
+	}
+>;
 
 /**
  * @deprecated Use {@link GetPropertiesWithPathInput} instead.

package/src/providers/s3/types/options.ts

@@ -2,7 +2,11 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { StorageAccessLevel } from '@aws-amplify/core';
-import { SigningOptions } from '@aws-amplify/core/internals/aws-client-utils';
+import { AWSCredentials } from '@aws-amplify/core/internals/utils';
+import {
+	CredentialsProviderOptions,
+	SigningOptions,
+} from '@aws-amplify/core/internals/aws-client-utils';
 
 import { TransferProgressEvent } from '../../../types';
 import {
@@ -11,12 +15,44 @@ import {
 	StorageSubpathStrategy,
 } from '../../../types/options';
 
+/**
+ * @internal
+ */
+export type AWSTemporaryCredentials = Required<
+	Pick<
+		AWSCredentials,
+		'accessKeyId' | 'secretAccessKey' | 'sessionToken' | 'expiration'
+	>
+>;
+
+/**
+ * @internal
+ */
+export type LocationCredentialsProvider = (
+	options?: CredentialsProviderOptions,
+) => Promise<{ credentials: AWSTemporaryCredentials }>;
+
+export interface BucketInfo {
+	bucketName: string;
+	region: string;
+}
+
+export type StorageBucket = string | BucketInfo;
 interface CommonOptions {
 	/**
 	 * Whether to use accelerate endpoint.
 	 * @default false
 	 */
 	useAccelerateEndpoint?: boolean;
+
+	/**
+	 * Async function returning AWS credentials for an API call. This function
+	 * is invoked with S3 locations(bucket and path).
+	 * If omitted, the global credentials configured in Amplify Auth
+	 * would be used.
+	 */
+	locationCredentialsProvider?: LocationCredentialsProvider;
+	bucket?: StorageBucket;
 }
 
 /**
@@ -183,6 +219,11 @@ export type UploadDataOptions = CommonOptions &
 		 * @see https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingMetadata.html#UserMetadata
 		 */
 		metadata?: Record<string, string>;
+		/**
+		 * Enforces target key does not already exist in S3 before committing upload.
+		 * @default false
+		 */
+		preventOverwrite?: boolean;
 	};
 
 /** @deprecated Use {@link UploadDataOptionsWithPath} instead. */
@@ -193,14 +234,23 @@ export type UploadDataOptionsWithPath = UploadDataOptions;
 export type CopySourceOptionsWithKey = ReadOptions & {
 	/** @deprecated This may be removed in the next major version. */
 	key: string;
+	bucket?: StorageBucket;
 };
 
 /** @deprecated This may be removed in the next major version. */
 export type CopyDestinationOptionsWithKey = WriteOptions & {
 	/** @deprecated This may be removed in the next major version. */
 	key: string;
+	bucket?: StorageBucket;
 };
 
+export interface CopyWithPathSourceOptions {
+	bucket?: StorageBucket;
+}
+export interface CopyWithPathDestinationOptions {
+	bucket?: StorageBucket;
+}
+
 /**
  * Internal only type for S3 API handlers' config parameter.
  *

package/src/providers/s3/utils/client/s3control/base.ts

@@ -0,0 +1,70 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	AmplifyUrl,
+	getAmplifyUserAgent,
+} from '@aws-amplify/core/internals/utils';
+import {
+	EndpointResolverOptions,
+	getDnsSuffix,
+	jitteredBackoff,
+} from '@aws-amplify/core/internals/aws-client-utils';
+
+import { retryDecider } from '../utils';
+
+/**
+ * The service name used to sign requests if the API requires authentication.
+ */
+export const SERVICE_NAME = 's3';
+
+/**
+ * Options for endpoint resolver.
+ *
+ * @internal
+ */
+export type S3EndpointResolverOptions = EndpointResolverOptions & {
+	/**
+	 * Fully qualified custom endpoint for S3. If this is set, this endpoint will be used regardless of region.
+	 */
+	customEndpoint?: string;
+};
+
+/**
+ * The endpoint resolver function that returns the endpoint URL for a given region, and input parameters.
+ */
+const endpointResolver = (
+	options: S3EndpointResolverOptions,
+	apiInput?: { AccountId?: string },
+) => {
+	const { region, customEndpoint } = options;
+	const { AccountId: accountId } = apiInput || {};
+	let endpoint: URL;
+	// 1. get base endpoint
+	if (customEndpoint) {
+		endpoint = new AmplifyUrl(customEndpoint);
+	} else if (accountId) {
+		// Control plane operations
+		endpoint = new AmplifyUrl(
+			`https://${accountId}.s3-control.${region}.${getDnsSuffix(region)}`,
+		);
+	} else {
+		endpoint = new AmplifyUrl(
+			`https://s3-control.${region}.${getDnsSuffix(region)}`,
+		);
+	}
+
+	return { url: endpoint };
+};
+
+/**
+ * @internal
+ */
+export const defaultConfig = {
+	service: SERVICE_NAME,
+	endpointResolver,
+	retryDecider,
+	computeDelay: jitteredBackoff,
+	userAgentValue: getAmplifyUserAgent(),
+	uriEscapePath: false, // Required by S3. See https://github.com/aws/aws-sdk-js-v3/blob/9ba012dfa3a3429aa2db0f90b3b0b3a7a31f9bc3/packages/signature-v4/src/SignatureV4.ts#L76-L83
+};

package/src/providers/s3/utils/client/s3control/getDataAccess.ts

@@ -0,0 +1,97 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	Endpoint,
+	HttpRequest,
+	HttpResponse,
+	parseMetadata,
+} from '@aws-amplify/core/internals/aws-client-utils';
+import {
+	AmplifyUrl,
+	AmplifyUrlSearchParams,
+} from '@aws-amplify/core/internals/utils';
+import { composeServiceApi } from '@aws-amplify/core/internals/aws-client-utils/composers';
+
+import {
+	assignStringVariables,
+	buildStorageServiceError,
+	deserializeTimestamp,
+	map,
+	parseXmlBody,
+	parseXmlError,
+	s3TransferHandler,
+} from '../utils';
+
+import type {
+	GetDataAccessCommandInput,
+	GetDataAccessCommandOutput,
+} from './types';
+import { defaultConfig } from './base';
+
+export type GetDataAccessInput = GetDataAccessCommandInput;
+
+export type GetDataAccessOutput = GetDataAccessCommandOutput;
+
+const getDataAccessSerializer = (
+	input: GetDataAccessInput,
+	endpoint: Endpoint,
+): HttpRequest => {
+	const headers = assignStringVariables({
+		'x-amz-account-id': input.AccountId,
+	});
+	const query = assignStringVariables({
+		durationSeconds: input.DurationSeconds,
+		permission: input.Permission,
+		privilege: input.Privilege,
+		target: input.Target,
+		targetType: input.TargetType,
+	});
+	const url = new AmplifyUrl(endpoint.url.toString());
+	url.search = new AmplifyUrlSearchParams(query).toString();
+
+	// Ref: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetDataAccess.html
+	url.pathname = '/v20180820/accessgrantsinstance/dataaccess';
+
+	return {
+		method: 'GET',
+		headers,
+		url,
+	};
+};
+
+const getDataAccessDeserializer = async (
+	response: HttpResponse,
+): Promise<GetDataAccessCommandOutput> => {
+	if (response.statusCode >= 300) {
+		// error is always set when statusCode >= 300
+		const error = (await parseXmlError(response)) as Error;
+		throw buildStorageServiceError(error, response.statusCode);
+	} else {
+		const parsed = await parseXmlBody(response);
+		const contents = map(parsed, {
+			Credentials: ['Credentials', deserializeCredentials],
+			MatchedGrantTarget: 'MatchedGrantTarget',
+		});
+
+		return {
+			$metadata: parseMetadata(response),
+			...contents,
+		};
+	}
+};
+
+const deserializeCredentials = (output: any) =>
+	map(output, {
+		AccessKeyId: 'AccessKeyId',
+		Expiration: ['Expiration', deserializeTimestamp],
+		SecretAccessKey: 'SecretAccessKey',
+		SessionToken: 'SessionToken',
+	});
+
+export const getDataAccess = composeServiceApi(
+	s3TransferHandler,
+	getDataAccessSerializer,
+	getDataAccessDeserializer,
+	{ ...defaultConfig, responseType: 'text' },
+);

package/src/providers/s3/utils/client/s3control/index.ts

@@ -0,0 +1,13 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export {
+	getDataAccess,
+	GetDataAccessInput,
+	GetDataAccessOutput,
+} from '../s3control/getDataAccess';
+export {
+	listCallerAccessGrants,
+	ListCallerAccessGrantsInput,
+	ListCallerAccessGrantsOutput,
+} from '../s3control/listCallerAccessGrants';

package/src/providers/s3/utils/client/s3control/listCallerAccessGrants.ts

@@ -0,0 +1,104 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	Endpoint,
+	HttpRequest,
+	HttpResponse,
+	parseMetadata,
+} from '@aws-amplify/core/internals/aws-client-utils';
+import {
+	AmplifyUrl,
+	AmplifyUrlSearchParams,
+} from '@aws-amplify/core/internals/utils';
+import { composeServiceApi } from '@aws-amplify/core/internals/aws-client-utils/composers';
+
+import {
+	assignStringVariables,
+	buildStorageServiceError,
+	emptyArrayGuard,
+	map,
+	parseXmlBody,
+	parseXmlError,
+	s3TransferHandler,
+} from '../utils';
+
+import type {
+	ListCallerAccessGrantsCommandInput,
+	ListCallerAccessGrantsCommandOutput,
+} from './types';
+import { defaultConfig } from './base';
+
+export type ListCallerAccessGrantsInput = ListCallerAccessGrantsCommandInput;
+
+export type ListCallerAccessGrantsOutput = ListCallerAccessGrantsCommandOutput;
+
+const listCallerAccessGrantsSerializer = (
+	input: ListCallerAccessGrantsInput,
+	endpoint: Endpoint,
+): HttpRequest => {
+	const headers = assignStringVariables({
+		'x-amz-account-id': input.AccountId,
+	});
+	const query = assignStringVariables({
+		grantscope: input.GrantScope,
+		maxResults: input.MaxResults,
+		nextToken: input.NextToken,
+	});
+	const url = new AmplifyUrl(endpoint.url.toString());
+	url.search = new AmplifyUrlSearchParams(query).toString();
+
+	// Ref: NA
+	url.pathname = '/v20180820/accessgrantsinstance/caller/grants';
+
+	return {
+		method: 'GET',
+		headers,
+		url,
+	};
+};
+
+const listCallerAccessGrantsDeserializer = async (
+	response: HttpResponse,
+): Promise<ListCallerAccessGrantsOutput> => {
+	if (response.statusCode >= 300) {
+		// error is always set when statusCode >= 300
+		const error = (await parseXmlError(response)) as Error;
+		throw buildStorageServiceError(error, response.statusCode);
+	} else {
+		const parsed = await parseXmlBody(response);
+		const contents = map(parsed, {
+			CallerAccessGrantsList: [
+				'CallerAccessGrantsList',
+				value =>
+					emptyArrayGuard(
+						value.AccessGrantsInstance,
+						deserializeAccessGrantsList,
+					),
+			],
+			NextToken: 'NextToken',
+		});
+
+		return {
+			$metadata: parseMetadata(response),
+			...contents,
+		};
+	}
+};
+
+const deserializeAccessGrantsList = (output: any[]) =>
+	output.map(deserializeCallerAccessGrant);
+
+const deserializeCallerAccessGrant = (output: any) =>
+	map(output, {
+		ApplicationArn: 'ApplicationArn',
+		GrantScope: 'GrantScope',
+		Permission: 'Permission',
+	});
+
+export const listCallerAccessGrants = composeServiceApi(
+	s3TransferHandler,
+	listCallerAccessGrantsSerializer,
+	listCallerAccessGrantsDeserializer,
+	{ ...defaultConfig, responseType: 'text' },
+);