@aws-amplify/storage 5.6.4-api-v6.2 → 5.6.4-api-v6.23

package/src/AwsClients/S3/getObject.ts

@@ -0,0 +1,173 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	Endpoint,
+	HttpRequest,
+	parseMetadata,
+	presignUrl,
+	UserAgentOptions,
+	PresignUrlOptions,
+	EMPTY_SHA256_HASH,
+} from '@aws-amplify/core/internals/aws-client-utils';
+import { composeServiceApi } from '@aws-amplify/core/internals/aws-client-utils/composers';
+import { USER_AGENT_HEADER } from '@aws-amplify/core';
+
+import { S3EndpointResolverOptions, defaultConfig } from './base';
+import type {
+	CompatibleHttpResponse,
+	GetObjectCommandInput,
+	GetObjectCommandOutput,
+} from './types';
+import {
+	deserializeBoolean,
+	deserializeMetadata,
+	deserializeNumber,
+	deserializeTimestamp,
+	map,
+	parseXmlError,
+	s3TransferHandler,
+	serializeObjectSsecOptionsToHeaders,
+	serializePathnameObjectKey,
+	CONTENT_SHA256_HEADER,
+} from './utils';
+
+export type GetObjectInput = Pick<
+	GetObjectCommandInput,
+	| 'Bucket'
+	| 'Key'
+	| 'ResponseCacheControl'
+	| 'ResponseContentDisposition'
+	| 'ResponseContentEncoding'
+	| 'ResponseContentLanguage'
+	| 'ResponseContentType'
+	| 'SSECustomerAlgorithm'
+	| 'SSECustomerKey'
+	// TODO(AllanZhengYP): remove in V6.
+	| 'SSECustomerKeyMD5'
+>;
+
+export type GetObjectOutput = GetObjectCommandOutput;
+
+const getObjectSerializer = async (
+	input: GetObjectInput,
+	endpoint: Endpoint
+): Promise<HttpRequest> => {
+	const headers = await serializeObjectSsecOptionsToHeaders(input);
+	const query = map(input, {
+		'response-cache-control': 'ResponseCacheControl',
+		'response-content-disposition': 'ResponseContentDisposition',
+		'response-content-encoding': 'ResponseContentEncoding',
+		'response-content-language': 'ResponseContentLanguage',
+		'response-content-type': 'ResponseContentType',
+	});
+	const url = new URL(endpoint.url.toString());
+	url.pathname = serializePathnameObjectKey(url, input.Key);
+	url.search = new URLSearchParams(query).toString();
+	return {
+		method: 'GET',
+		headers,
+		url,
+	};
+};
+
+const getObjectDeserializer = async (
+	response: CompatibleHttpResponse
+): Promise<GetObjectOutput> => {
+	if (response.statusCode >= 300) {
+		const error = await parseXmlError(response);
+		throw error;
+	} else if (!response.body) {
+		throw new Error('Got empty response body.');
+	} else {
+		return {
+			...map(response.headers, {
+				DeleteMarker: ['x-amz-delete-marker', deserializeBoolean],
+				AcceptRanges: 'accept-ranges',
+				Expiration: 'x-amz-expiration',
+				Restore: 'x-amz-restore',
+				LastModified: ['last-modified', deserializeTimestamp],
+				ContentLength: ['content-length', deserializeNumber],
+				ETag: 'etag',
+				ChecksumCRC32: 'x-amz-checksum-crc32',
+				ChecksumCRC32C: 'x-amz-checksum-crc32c',
+				ChecksumSHA1: 'x-amz-checksum-sha1',
+				ChecksumSHA256: 'x-amz-checksum-sha256',
+				MissingMeta: ['x-amz-missing-meta', deserializeNumber],
+				VersionId: 'x-amz-version-id',
+				CacheControl: 'cache-control',
+				ContentDisposition: 'content-disposition',
+				ContentEncoding: 'content-encoding',
+				ContentLanguage: 'content-language',
+				ContentRange: 'content-range',
+				ContentType: 'content-type',
+				Expires: ['expires', deserializeTimestamp],
+				WebsiteRedirectLocation: 'x-amz-website-redirect-location',
+				ServerSideEncryption: 'x-amz-server-side-encryption',
+				SSECustomerAlgorithm: 'x-amz-server-side-encryption-customer-algorithm',
+				SSECustomerKeyMD5: 'x-amz-server-side-encryption-customer-key-md5',
+				SSEKMSKeyId: 'x-amz-server-side-encryption-aws-kms-key-id',
+				BucketKeyEnabled: [
+					'x-amz-server-side-encryption-bucket-key-enabled',
+					deserializeBoolean,
+				],
+				StorageClass: 'x-amz-storage-class',
+				RequestCharged: 'x-amz-request-charged',
+				ReplicationStatus: 'x-amz-replication-status',
+				PartsCount: ['x-amz-mp-parts-count', deserializeNumber],
+				TagCount: ['x-amz-tagging-count', deserializeNumber],
+				ObjectLockMode: 'x-amz-object-lock-mode',
+				ObjectLockRetainUntilDate: [
+					'x-amz-object-lock-retain-until-date',
+					deserializeTimestamp,
+				],
+				ObjectLockLegalHoldStatus: 'x-amz-object-lock-legal-hold',
+			}),
+			Metadata: deserializeMetadata(response.headers),
+			$metadata: parseMetadata(response),
+			Body: response.body,
+		};
+	}
+};
+
+export const getObject = composeServiceApi(
+	s3TransferHandler,
+	getObjectSerializer,
+	getObjectDeserializer,
+	{ ...defaultConfig, responseType: 'blob' }
+);
+
+/**
+ * Get a presigned URL for the `getObject` API.
+ *
+ * @internal
+ */
+export const getPresignedGetObjectUrl = async (
+	config: UserAgentOptions & PresignUrlOptions & S3EndpointResolverOptions,
+	input: GetObjectInput
+): Promise<string> => {
+	const endpoint = defaultConfig.endpointResolver(config, input);
+	const { url, headers, method } = await getObjectSerializer(input, endpoint);
+
+	// TODO: set content sha256 query parameter with value of UNSIGNED-PAYLOAD.
+	// It requires changes in presignUrl. Without this change, the generated url still works,
+	// but not the same as other tools like AWS SDK and CLI.
+	url.searchParams.append(CONTENT_SHA256_HEADER, EMPTY_SHA256_HASH);
+	url.searchParams.append(
+		config.userAgentHeader ?? USER_AGENT_HEADER,
+		config.userAgentValue
+	);
+
+	for (const [headerName, value] of Object.entries(headers).sort(
+		([key1], [key2]) => key1.localeCompare(key2)
+	)) {
+		url.searchParams.append(headerName, value);
+	}
+	return presignUrl(
+		{ method, url, body: null },
+		{
+			...defaultConfig,
+			...config,
+		}
+	).toString();
+};

package/src/AwsClients/S3/headObject.ts

@@ -0,0 +1,91 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	Endpoint,
+	HttpRequest,
+	parseMetadata,
+} from '@aws-amplify/core/internals/aws-client-utils';
+import { composeServiceApi } from '@aws-amplify/core/internals/aws-client-utils/composers';
+import { defaultConfig } from './base';
+import type {
+	CompatibleHttpResponse,
+	HeadObjectCommandInput,
+	HeadObjectCommandOutput,
+} from './types';
+import {
+	deserializeMetadata,
+	deserializeNumber,
+	deserializeTimestamp,
+	map,
+	parseXmlError,
+	s3TransferHandler,
+	serializeObjectSsecOptionsToHeaders,
+	serializePathnameObjectKey,
+} from './utils';
+
+export type HeadObjectInput = Pick<
+	HeadObjectCommandInput,
+	| 'Bucket'
+	| 'Key'
+	| 'SSECustomerKey'
+	// TODO(AllanZhengYP): remove in V6.
+	| 'SSECustomerKeyMD5'
+	| 'SSECustomerAlgorithm'
+>;
+
+export type HeadObjectOutput = Pick<
+	HeadObjectCommandOutput,
+	| '$metadata'
+	| 'ContentLength'
+	| 'ContentType'
+	| 'ETag'
+	| 'LastModified'
+	| 'Metadata'
+	| 'VersionId'
+>;
+
+const headObjectSerializer = async (
+	input: HeadObjectInput,
+	endpoint: Endpoint
+): Promise<HttpRequest> => {
+	const headers = await serializeObjectSsecOptionsToHeaders(input);
+	const url = new URL(endpoint.url.toString());
+	url.pathname = serializePathnameObjectKey(url, input.Key);
+	return {
+		method: 'HEAD',
+		headers,
+		url,
+	};
+};
+
+const headObjectDeserializer = async (
+	response: CompatibleHttpResponse
+): Promise<HeadObjectOutput> => {
+	if (response.statusCode >= 300) {
+		const error = await parseXmlError(response);
+		throw error;
+	} else {
+		const contents = {
+			...map(response.headers, {
+				ContentLength: ['content-length', deserializeNumber],
+				ContentType: 'content-type',
+				ETag: 'etag',
+				LastModified: ['last-modified', deserializeTimestamp],
+				VersionId: 'x-amz-version-id',
+			}),
+			Metadata: deserializeMetadata(response.headers),
+		};
+		return {
+			$metadata: parseMetadata(response),
+			...contents,
+		};
+	}
+};
+
+export const headObject = composeServiceApi(
+	s3TransferHandler,
+	headObjectSerializer,
+	headObjectDeserializer,
+	{ ...defaultConfig, responseType: 'text' }
+);

package/src/AwsClients/S3/index.native.ts

@@ -0,0 +1,42 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import '@aws-amplify/core/polyfills/URL'; // TODO: [v6] install react-native-url-polyfill separately
+
+export { SERVICE_NAME } from './base';
+export {
+	getObject,
+	GetObjectInput,
+	GetObjectOutput,
+	getPresignedGetObjectUrl,
+} from './getObject';
+export {
+	listObjectsV2,
+	ListObjectsV2Input,
+	ListObjectsV2Output,
+} from './listObjectsV2';
+export { putObject, PutObjectInput, PutObjectOutput } from './putObject';
+export {
+	createMultipartUpload,
+	CreateMultipartUploadInput,
+	CreateMultipartUploadOutput,
+} from './createMultipartUpload';
+export { uploadPart, UploadPartInput, UploadPartOutput } from './uploadPart';
+export {
+	completeMultipartUpload,
+	CompleteMultipartUploadInput,
+	CompleteMultipartUploadOutput,
+} from './completeMultipartUpload';
+export { listParts, ListPartsInput, ListPartsOutput } from './listParts';
+export {
+	abortMultipartUpload,
+	AbortMultipartUploadInput,
+	AbortMultipartUploadOutput,
+} from './abortMultipartUpload';
+export { copyObject, CopyObjectInput, CopyObjectOutput } from './copyObject';
+export { headObject, HeadObjectInput, HeadObjectOutput } from './headObject';
+export {
+	deleteObject,
+	DeleteObjectInput,
+	DeleteObjectOutput,
+} from './deleteObject';
+export { CompletedPart, Part, _Object } from './types';

package/src/AwsClients/S3/index.ts

@@ -0,0 +1,41 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { SERVICE_NAME } from './base';
+export {
+	getObject,
+	GetObjectInput,
+	GetObjectOutput,
+	getPresignedGetObjectUrl,
+} from './getObject';
+export {
+	listObjectsV2,
+	ListObjectsV2Input,
+	ListObjectsV2Output,
+} from './listObjectsV2';
+export { putObject, PutObjectInput, PutObjectOutput } from './putObject';
+export {
+	createMultipartUpload,
+	CreateMultipartUploadInput,
+	CreateMultipartUploadOutput,
+} from './createMultipartUpload';
+export { uploadPart, UploadPartInput, UploadPartOutput } from './uploadPart';
+export {
+	completeMultipartUpload,
+	CompleteMultipartUploadInput,
+	CompleteMultipartUploadOutput,
+} from './completeMultipartUpload';
+export { listParts, ListPartsInput, ListPartsOutput } from './listParts';
+export {
+	abortMultipartUpload,
+	AbortMultipartUploadInput,
+	AbortMultipartUploadOutput,
+} from './abortMultipartUpload';
+export { copyObject, CopyObjectInput, CopyObjectOutput } from './copyObject';
+export { headObject, HeadObjectInput, HeadObjectOutput } from './headObject';
+export {
+	deleteObject,
+	DeleteObjectInput,
+	DeleteObjectOutput,
+} from './deleteObject';
+export { CompletedPart, Part, _Object } from './types';

package/src/AwsClients/S3/listObjectsV2.ts

@@ -0,0 +1,130 @@
+// 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 { composeServiceApi } from '@aws-amplify/core/internals/aws-client-utils/composers';
+import type {
+	ListObjectsV2CommandInput,
+	ListObjectsV2CommandOutput,
+} from './types';
+import { defaultConfig } from './base';
+import {
+	assignStringVariables,
+	deserializeBoolean,
+	deserializeNumber,
+	deserializeTimestamp,
+	emptyArrayGuard,
+	map,
+	parseXmlBody,
+	parseXmlError,
+	s3TransferHandler,
+	serializePathnameObjectKey,
+} from './utils';
+
+export type ListObjectsV2Input = ListObjectsV2CommandInput;
+
+export type ListObjectsV2Output = ListObjectsV2CommandOutput;
+
+const listObjectsV2Serializer = (
+	input: ListObjectsV2Input,
+	endpoint: Endpoint
+): HttpRequest => {
+	const headers = assignStringVariables({
+		'x-amz-request-payer': input.RequestPayer,
+		'x-amz-expected-bucket-owner': input.ExpectedBucketOwner,
+	});
+	const query = assignStringVariables({
+		'list-type': '2',
+		'continuation-token': input.ContinuationToken,
+		delimiter: input.Delimiter,
+		'encoding-type': input.EncodingType,
+		'fetch-owner': input.FetchOwner,
+		'max-keys': input.MaxKeys,
+		prefix: input.Prefix,
+		'start-after': input.StartAfter,
+	});
+	const url = new URL(endpoint.url.toString());
+	url.search = new URLSearchParams(query).toString();
+	return {
+		method: 'GET',
+		headers,
+		url,
+	};
+};
+
+const listObjectsV2Deserializer = async (
+	response: HttpResponse
+): Promise<ListObjectsV2Output> => {
+	if (response.statusCode >= 300) {
+		const error = await parseXmlError(response);
+		throw error;
+	} else {
+		const parsed = await parseXmlBody(response);
+		const contents = map(parsed, {
+			CommonPrefixes: [
+				'CommonPrefixes',
+				value => emptyArrayGuard(value, deserializeCommonPrefixList),
+			],
+			Contents: [
+				'Contents',
+				value => emptyArrayGuard(value, deserializeObjectList),
+			],
+			ContinuationToken: 'ContinuationToken',
+			Delimiter: 'Delimiter',
+			EncodingType: 'EncodingType',
+			IsTruncated: ['IsTruncated', deserializeBoolean],
+			KeyCount: ['KeyCount', deserializeNumber],
+			MaxKeys: ['MaxKeys', deserializeNumber],
+			Name: 'Name',
+			NextContinuationToken: 'NextContinuationToken',
+			Prefix: 'Prefix',
+			StartAfter: 'StartAfter',
+		});
+		return {
+			$metadata: parseMetadata(response),
+			...contents,
+		};
+	}
+};
+
+const deserializeCommonPrefixList = (output: any[]) =>
+	output.map(deserializeCommonPrefix);
+
+const deserializeCommonPrefix = (output: any) =>
+	map(output, {
+		Prefix: 'Prefix',
+	});
+
+const deserializeObjectList = (output: any[]) => output.map(deserializeObject);
+
+const deserializeObject = (output: any) =>
+	map(output, {
+		Key: 'Key',
+		LastModified: ['LastModified', deserializeTimestamp],
+		ETag: 'ETag',
+		ChecksumAlgorithm: [
+			'ChecksumAlgorithm',
+			value => emptyArrayGuard(value, deserializeChecksumAlgorithmList),
+		],
+		Size: ['Size', deserializeNumber],
+		StorageClass: 'StorageClass',
+		Owner: ['Owner', deserializeOwner],
+	});
+
+const deserializeChecksumAlgorithmList = (output: any[]) =>
+	output.map(entry => String(entry));
+
+const deserializeOwner = (output: any) =>
+	map(output, { DisplayName: 'DisplayName', ID: 'ID' });
+
+export const listObjectsV2 = composeServiceApi(
+	s3TransferHandler,
+	listObjectsV2Serializer,
+	listObjectsV2Deserializer,
+	{ ...defaultConfig, responseType: 'text' }
+);

package/src/AwsClients/S3/listParts.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 { composeServiceApi } from '@aws-amplify/core/internals/aws-client-utils/composers';
+import type {
+	ListPartsCommandInput,
+	ListPartsCommandOutput,
+	CompletedPart,
+} from './types';
+import { defaultConfig } from './base';
+import {
+	emptyArrayGuard,
+	serializeObjectSsecOptionsToHeaders,
+	map,
+	parseXmlBody,
+	parseXmlError,
+	s3TransferHandler,
+	deserializeNumber,
+	serializePathnameObjectKey,
+} from './utils';
+
+export type ListPartsInput = Pick<
+	ListPartsCommandInput,
+	| 'Bucket'
+	| 'Key'
+	| 'UploadId'
+	| 'SSECustomerAlgorithm'
+	| 'SSECustomerKey'
+	// TODO(AllanZhengYP): remove in V6.
+	| 'SSECustomerKeyMD5'
+>;
+
+export type ListPartsOutput = Pick<
+	ListPartsCommandOutput,
+	'Parts' | 'UploadId' | '$metadata'
+>;
+
+const listPartsSerializer = async (
+	input: ListPartsInput,
+	endpoint: Endpoint
+): Promise<HttpRequest> => {
+	const headers = await serializeObjectSsecOptionsToHeaders(input);
+	const url = new URL(endpoint.url.toString());
+	url.pathname = serializePathnameObjectKey(url, input.Key);
+	url.search = new URLSearchParams({
+		uploadId: input.UploadId,
+	}).toString();
+	return {
+		method: 'GET',
+		headers,
+		url,
+	};
+};
+
+const listPartsDeserializer = async (
+	response: HttpResponse
+): Promise<ListPartsOutput> => {
+	if (response.statusCode >= 300) {
+		const error = await parseXmlError(response);
+		throw error;
+	} else {
+		const parsed = await parseXmlBody(response);
+		const contents = map(parsed, {
+			UploadId: 'UploadId',
+			Parts: [
+				'Part',
+				value => emptyArrayGuard(value, deserializeCompletedPartList),
+			],
+		});
+		return {
+			$metadata: parseMetadata(response),
+			...contents,
+		};
+	}
+};
+
+const deserializeCompletedPartList = (input: any[]): CompletedPart[] =>
+	input.map(item =>
+		map(item, {
+			PartNumber: ['PartNumber', deserializeNumber],
+			ETag: 'ETag',
+			Size: ['Size', deserializeNumber],
+		})
+	);
+
+export const listParts = composeServiceApi(
+	s3TransferHandler,
+	listPartsSerializer,
+	listPartsDeserializer,
+	{ ...defaultConfig, responseType: 'text' }
+);

package/src/AwsClients/S3/putObject.ts

@@ -0,0 +1,99 @@
+// 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 { composeServiceApi } from '@aws-amplify/core/internals/aws-client-utils/composers';
+
+import { defaultConfig } from './base';
+import type { PutObjectCommandInput, PutObjectCommandOutput } from './types';
+import {
+	assignStringVariables,
+	map,
+	parseXmlError,
+	s3TransferHandler,
+	serializeObjectConfigsToHeaders,
+	serializePathnameObjectKey,
+} from './utils';
+import type { S3ProviderPutConfig } from '../../types';
+
+/**
+ * Reference: {@link S3ProviderPutConfig}
+ */
+export type PutObjectInput = Pick<
+	PutObjectCommandInput,
+	| 'Bucket'
+	| 'Key'
+	| 'Body'
+	| 'ServerSideEncryption'
+	| 'SSECustomerAlgorithm'
+	| 'SSECustomerKey'
+	// TODO(AllanZhengYP): remove in V6.
+	| 'SSECustomerKeyMD5'
+	| 'SSEKMSKeyId'
+	| 'ACL'
+	| 'CacheControl'
+	| 'ContentDisposition'
+	| 'ContentEncoding'
+	| 'ContentType'
+	| 'ContentMD5'
+	| 'Expires'
+	| 'Metadata'
+	| 'Tagging'
+>;
+
+export type PutObjectOutput = Pick<
+	PutObjectCommandOutput,
+	// PutObject output is not exposed in public API, but only logged in the debug mode
+	// so we only expose $metadata, ETag and VersionId for debug purpose.
+	'$metadata' | 'ETag' | 'VersionId'
+>;
+
+const putObjectSerializer = async (
+	input: PutObjectInput,
+	endpoint: Endpoint
+): Promise<HttpRequest> => {
+	const headers = {
+		...(await serializeObjectConfigsToHeaders({
+			...input,
+			ContentType: input.ContentType ?? 'application/octet-stream',
+		})),
+		...assignStringVariables({ 'content-md5': input.ContentMD5 }),
+	};
+	const url = new URL(endpoint.url.toString());
+	url.pathname = serializePathnameObjectKey(url, input.Key);
+	return {
+		method: 'PUT',
+		headers,
+		url,
+		body: input.Body,
+	};
+};
+
+const putObjectDeserializer = async (
+	response: HttpResponse
+): Promise<PutObjectOutput> => {
+	if (response.statusCode >= 300) {
+		const error = await parseXmlError(response);
+		throw error;
+	} else {
+		return {
+			...map(response.headers, {
+				ETag: 'etag',
+				VersionId: 'x-amz-version-id',
+			}),
+			$metadata: parseMetadata(response),
+		};
+	}
+};
+
+export const putObject = composeServiceApi(
+	s3TransferHandler,
+	putObjectSerializer,
+	putObjectDeserializer,
+	{ ...defaultConfig, responseType: 'text' }
+);

package/src/AwsClients/S3/runtime/base64/index.browser.ts

@@ -0,0 +1,21 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+function bytesToBase64(bytes: Uint8Array): string {
+	const base64Str = Array.from(bytes, x => String.fromCodePoint(x)).join('');
+	return btoa(base64Str);
+}
+
+export function utf8Encode(input: string): Uint8Array {
+	return new TextEncoder().encode(input);
+}
+
+export function toBase64(input: string | ArrayBufferView): string {
+	if (typeof input === 'string') {
+		return bytesToBase64(utf8Encode(input));
+	}
+
+	return bytesToBase64(
+		new Uint8Array(input.buffer, input.byteOffset, input.byteLength)
+	);
+}