@aws-amplify/storage 6.0.17-unstable.e316a2e.0 → 6.0.17

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

@@ -10,38 +10,38 @@ import {
 	StorageListPaginateOptions,
 } from '../../../types/options';
 
-type CommonOptions = {
+interface CommonOptions {
 	/**
 	 * Whether to use accelerate endpoint.
 	 * @default false
 	 */
 	useAccelerateEndpoint?: boolean;
-};
+}
 
 type ReadOptions =
 	| { accessLevel?: 'guest' | 'private' }
 	| { accessLevel: 'protected'; targetIdentityId?: string };
 
-type WriteOptions = {
+interface WriteOptions {
 	accessLevel?: StorageAccessLevel;
-};
+}
 
-type BytesRangeOptions = {
+interface BytesRangeOptions {
 	bytesRange?: {
 		start: number;
 		end: number;
 	};
-};
+}
 
 /**
  * Transfer-related options type for S3 downloadData, uploadData APIs.
  */
-type TransferOptions = {
+interface TransferOptions {
 	/**
 	 * Callback function tracking the upload/download progress.
 	 */
-	onProgress?: (event: TransferProgressEvent) => void;
-};
+	onProgress?(event: TransferProgressEvent): void;
+}
 
 /**
  * Input options type for S3 getProperties API.
@@ -130,10 +130,10 @@ export type CopyDestinationOptions = WriteOptions & {
  *
  * @internal
  */
-export type ResolvedS3Config = {
+export interface ResolvedS3Config {
 	region: string;
 	credentials: AWSCredentials;
 	customEndpoint?: string;
 	forcePathStyle?: boolean;
 	useAccelerateEndpoint?: boolean;
-};
+}

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

@@ -2,11 +2,11 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import {
+	DownloadTask,
 	StorageDownloadDataOutput,
 	StorageGetUrlOutput,
 	StorageItem,
 	StorageListOutput,
-	DownloadTask,
 	UploadTask,
 } from '../../../types';
 

package/src/providers/s3/utils/client/abortMultipartUpload.ts

@@ -13,8 +13,8 @@ import {
 	AmplifyUrlSearchParams,
 } from '@aws-amplify/core/internals/utils';
 import { MetadataBearer } from '@aws-sdk/types';
-import type { AbortMultipartUploadCommandInput } from './types';
 
+import type { AbortMultipartUploadCommandInput } from './types';
 import { defaultConfig } from './base';
 import {
 	buildStorageServiceError,
@@ -33,7 +33,7 @@ export type AbortMultipartUploadOutput = MetadataBearer;
 
 const abortMultipartUploadSerializer = (
 	input: AbortMultipartUploadInput,
-	endpoint: Endpoint
+	endpoint: Endpoint,
 ): HttpRequest => {
 	const url = new AmplifyUrl(endpoint.url.toString());
 	validateS3RequiredParameter(!!input.Key, 'Key');
@@ -42,6 +42,7 @@ const abortMultipartUploadSerializer = (
 	url.search = new AmplifyUrlSearchParams({
 		uploadId: input.UploadId,
 	}).toString();
+
 	return {
 		method: 'DELETE',
 		headers: {},
@@ -50,7 +51,7 @@ const abortMultipartUploadSerializer = (
 };
 
 const abortMultipartUploadDeserializer = async (
-	response: HttpResponse
+	response: HttpResponse,
 ): Promise<AbortMultipartUploadOutput> => {
 	if (response.statusCode >= 300) {
 		const error = (await parseXmlError(response)) as Error;
@@ -66,5 +67,5 @@ export const abortMultipartUpload = composeServiceApi(
 	s3TransferHandler,
 	abortMultipartUploadSerializer,
 	abortMultipartUploadDeserializer,
-	{ ...defaultConfig, responseType: 'text' }
+	{ ...defaultConfig, responseType: 'text' },
 );

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

@@ -2,18 +2,19 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import {
-	getAmplifyUserAgent,
 	AmplifyUrl,
+	getAmplifyUserAgent,
 } from '@aws-amplify/core/internals/utils';
 import {
+	EndpointResolverOptions,
 	getDnsSuffix,
-	jitteredBackoff,
 	getRetryDecider,
-	EndpointResolverOptions,
+	jitteredBackoff,
 } from '@aws-amplify/core/internals/aws-client-utils';
+
 import { parseXmlError } from './utils';
 
-const DOMAIN_PATTERN = /^[a-z0-9][a-z0-9\.\-]{1,61}[a-z0-9]$/;
+const DOMAIN_PATTERN = /^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$/;
 const IP_ADDRESS_PATTERN = /(\d+\.){3}\d+/;
 const DOTS_PATTERN = /\.\./;
 
@@ -52,7 +53,7 @@ export type S3EndpointResolverOptions = EndpointResolverOptions & {
  */
 const endpointResolver = (
 	options: S3EndpointResolverOptions,
-	apiInput?: { Bucket?: string }
+	apiInput?: { Bucket?: string },
 ) => {
 	const { region, useAccelerateEndpoint, customEndpoint, forcePathStyle } =
 		options;
@@ -63,7 +64,7 @@ const endpointResolver = (
 	} else if (useAccelerateEndpoint) {
 		if (forcePathStyle) {
 			throw new Error(
-				'Path style URLs are not supported with S3 Transfer Acceleration.'
+				'Path style URLs are not supported with S3 Transfer Acceleration.',
 			);
 		}
 		endpoint = new AmplifyUrl(`https://s3-accelerate.${getDnsSuffix(region)}`);
@@ -81,6 +82,7 @@ const endpointResolver = (
 			endpoint.host = `${apiInput.Bucket}.${endpoint.host}`;
 		}
 	}
+
 	return { url: endpoint };
 };
 

package/src/providers/s3/utils/client/completeMultipartUpload.ts

@@ -12,6 +12,7 @@ import {
 	AmplifyUrlSearchParams,
 } from '@aws-amplify/core/internals/utils';
 import { composeServiceApi } from '@aws-amplify/core/internals/aws-client-utils/composers';
+
 import type {
 	CompleteMultipartUploadCommandInput,
 	CompleteMultipartUploadCommandOutput,
@@ -44,7 +45,7 @@ export type CompleteMultipartUploadOutput = Pick<
 
 const completeMultipartUploadSerializer = async (
 	input: CompleteMultipartUploadInput,
-	endpoint: Endpoint
+	endpoint: Endpoint,
 ): Promise<HttpRequest> => {
 	const headers = {
 		'content-type': 'application/xml',
@@ -57,6 +58,7 @@ const completeMultipartUploadSerializer = async (
 		uploadId: input.UploadId,
 	}).toString();
 	validateS3RequiredParameter(!!input.MultipartUpload, 'MultipartUpload');
+
 	return {
 		method: 'POST',
 		headers,
@@ -68,13 +70,14 @@ const completeMultipartUploadSerializer = async (
 };
 
 const serializeCompletedMultipartUpload = (
-	input: CompletedMultipartUpload
+	input: CompletedMultipartUpload,
 ): string => {
 	if (!input.Parts?.length) {
 		throw new Error(`${INVALID_PARAMETER_ERROR_MSG}: ${input}`);
 	}
+
 	return `<CompleteMultipartUpload xmlns="http://s3.amazonaws.com/doc/2006-03-01/">${input.Parts.map(
-		serializeCompletedPartList
+		serializeCompletedPartList,
 	).join('')}</CompleteMultipartUpload>`;
 };
 
@@ -82,6 +85,7 @@ const serializeCompletedPartList = (input: CompletedPart): string => {
 	if (!input.ETag || input.PartNumber == null) {
 		throw new Error(`${INVALID_PARAMETER_ERROR_MSG}: ${input}`);
 	}
+
 	return `<Part><ETag>${input.ETag}</ETag><PartNumber>${input.PartNumber}</PartNumber></Part>`;
 };
 
@@ -100,11 +104,12 @@ const parseXmlBodyOrThrow = async (response: HttpResponse): Promise<any> => {
 		})) as Error;
 		throw buildStorageServiceError(error, response.statusCode);
 	}
+
 	return parsed;
 };
 
 const completeMultipartUploadDeserializer = async (
-	response: HttpResponse
+	response: HttpResponse,
 ): Promise<CompleteMultipartUploadOutput> => {
 	if (response.statusCode >= 300) {
 		const error = (await parseXmlError(response)) as Error;
@@ -116,6 +121,7 @@ const completeMultipartUploadDeserializer = async (
 			Key: 'Key',
 			Location: 'Location',
 		});
+
 		return {
 			$metadata: parseMetadata(response),
 			...contents,
@@ -128,7 +134,7 @@ const completeMultipartUploadDeserializer = async (
 // Ref: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html#API_CompleteMultipartUpload_Example_4
 const retryWhenErrorWith200StatusCode = async (
 	response?: HttpResponse,
-	error?: unknown
+	error?: unknown,
 ): Promise<boolean> => {
 	if (!response) {
 		return false;
@@ -141,10 +147,12 @@ const retryWhenErrorWith200StatusCode = async (
 		if (parsed.Code !== undefined && parsed.Message !== undefined) {
 			return true;
 		}
+
 		return false;
 	}
 
 	const defaultRetryDecider = defaultConfig.retryDecider;
+
 	return defaultRetryDecider(response, error);
 };
 
@@ -156,5 +164,5 @@ export const completeMultipartUpload = composeServiceApi(
 		...defaultConfig,
 		responseType: 'text',
 		retryDecider: retryWhenErrorWith200StatusCode,
-	}
+	},
 );

package/src/providers/s3/utils/client/copyObject.ts

@@ -9,14 +9,15 @@ import {
 } from '@aws-amplify/core/internals/aws-client-utils';
 import { AmplifyUrl } from '@aws-amplify/core/internals/utils';
 import { composeServiceApi } from '@aws-amplify/core/internals/aws-client-utils/composers';
+
 import type { CopyObjectCommandInput, CopyObjectCommandOutput } from './types';
 import { defaultConfig } from './base';
 import {
+	assignStringVariables,
 	buildStorageServiceError,
 	parseXmlBody,
 	parseXmlError,
 	s3TransferHandler,
-	assignStringVariables,
 	serializeObjectConfigsToHeaders,
 	serializePathnameObjectKey,
 	validateS3RequiredParameter,
@@ -42,7 +43,7 @@ export type CopyObjectOutput = CopyObjectCommandOutput;
 
 const copyObjectSerializer = async (
 	input: CopyObjectInput,
-	endpoint: Endpoint
+	endpoint: Endpoint,
 ): Promise<HttpRequest> => {
 	const headers = {
 		...(await serializeObjectConfigsToHeaders(input)),
@@ -54,6 +55,7 @@ const copyObjectSerializer = async (
 	const url = new AmplifyUrl(endpoint.url.toString());
 	validateS3RequiredParameter(!!input.Key, 'Key');
 	url.pathname = serializePathnameObjectKey(url, input.Key);
+
 	return {
 		method: 'PUT',
 		headers,
@@ -62,13 +64,14 @@ const copyObjectSerializer = async (
 };
 
 const copyObjectDeserializer = async (
-	response: HttpResponse
+	response: HttpResponse,
 ): Promise<CopyObjectOutput> => {
 	if (response.statusCode >= 300) {
 		const error = (await parseXmlError(response)) as Error;
 		throw buildStorageServiceError(error, response.statusCode);
 	} else {
 		await parseXmlBody(response);
+
 		return {
 			$metadata: parseMetadata(response),
 		};
@@ -79,5 +82,5 @@ export const copyObject = composeServiceApi(
 	s3TransferHandler,
 	copyObjectSerializer,
 	copyObjectDeserializer,
-	{ ...defaultConfig, responseType: 'text' }
+	{ ...defaultConfig, responseType: 'text' },
 );

package/src/providers/s3/utils/client/createMultipartUpload.ts

@@ -9,22 +9,22 @@ import {
 } from '@aws-amplify/core/internals/aws-client-utils';
 import { AmplifyUrl } from '@aws-amplify/core/internals/utils';
 import { composeServiceApi } from '@aws-amplify/core/internals/aws-client-utils/composers';
+
 import type {
 	CreateMultipartUploadCommandInput,
 	CreateMultipartUploadCommandOutput,
 } from './types';
 import type { PutObjectInput } from './putObject';
-
 import { defaultConfig } from './base';
 import {
 	buildStorageServiceError,
-	validateS3RequiredParameter,
 	map,
 	parseXmlBody,
 	parseXmlError,
 	s3TransferHandler,
 	serializeObjectConfigsToHeaders,
 	serializePathnameObjectKey,
+	validateS3RequiredParameter,
 } from './utils';
 
 export type CreateMultipartUploadInput = Extract<
@@ -39,13 +39,14 @@ export type CreateMultipartUploadOutput = Pick<
 
 const createMultipartUploadSerializer = async (
 	input: CreateMultipartUploadInput,
-	endpoint: Endpoint
+	endpoint: Endpoint,
 ): Promise<HttpRequest> => {
 	const headers = await serializeObjectConfigsToHeaders(input);
 	const url = new AmplifyUrl(endpoint.url.toString());
 	validateS3RequiredParameter(!!input.Key, 'Key');
 	url.pathname = serializePathnameObjectKey(url, input.Key);
 	url.search = 'uploads';
+
 	return {
 		method: 'POST',
 		headers,
@@ -54,7 +55,7 @@ const createMultipartUploadSerializer = async (
 };
 
 const createMultipartUploadDeserializer = async (
-	response: HttpResponse
+	response: HttpResponse,
 ): Promise<CreateMultipartUploadOutput> => {
 	if (response.statusCode >= 300) {
 		const error = (await parseXmlError(response)) as Error;
@@ -64,6 +65,7 @@ const createMultipartUploadDeserializer = async (
 		const contents = map(parsed, {
 			UploadId: 'UploadId',
 		});
+
 		return {
 			$metadata: parseMetadata(response),
 			...contents,
@@ -75,5 +77,5 @@ export const createMultipartUpload = composeServiceApi(
 	s3TransferHandler,
 	createMultipartUploadSerializer,
 	createMultipartUploadDeserializer,
-	{ ...defaultConfig, responseType: 'text' }
+	{ ...defaultConfig, responseType: 'text' },
 );

package/src/providers/s3/utils/client/deleteObject.ts

@@ -9,11 +9,11 @@ import {
 } from '@aws-amplify/core/internals/aws-client-utils';
 import { AmplifyUrl } from '@aws-amplify/core/internals/utils';
 import { composeServiceApi } from '@aws-amplify/core/internals/aws-client-utils/composers';
+
 import type {
 	DeleteObjectCommandInput,
 	DeleteObjectCommandOutput,
 } from './types';
-
 import { defaultConfig } from './base';
 import {
 	buildStorageServiceError,
@@ -24,7 +24,6 @@ import {
 	serializePathnameObjectKey,
 	validateS3RequiredParameter,
 } from './utils';
-import { StorageError } from '../../../../errors/StorageError';
 
 export type DeleteObjectInput = Pick<
 	DeleteObjectCommandInput,
@@ -35,11 +34,12 @@ export type DeleteObjectOutput = DeleteObjectCommandOutput;
 
 const deleteObjectSerializer = (
 	input: DeleteObjectInput,
-	endpoint: Endpoint
+	endpoint: Endpoint,
 ): HttpRequest => {
 	const url = new AmplifyUrl(endpoint.url.toString());
 	validateS3RequiredParameter(!!input.Key, 'Key');
 	url.pathname = serializePathnameObjectKey(url, input.Key);
+
 	return {
 		method: 'DELETE',
 		headers: {},
@@ -48,7 +48,7 @@ const deleteObjectSerializer = (
 };
 
 const deleteObjectDeserializer = async (
-	response: HttpResponse
+	response: HttpResponse,
 ): Promise<DeleteObjectOutput> => {
 	if (response.statusCode >= 300) {
 		// error is always set when statusCode >= 300
@@ -60,6 +60,7 @@ const deleteObjectDeserializer = async (
 			VersionId: 'x-amz-version-id',
 			RequestCharged: 'x-amz-request-charged',
 		});
+
 		return {
 			...content,
 			$metadata: parseMetadata(response),
@@ -71,5 +72,5 @@ export const deleteObject = composeServiceApi(
 	s3TransferHandler,
 	deleteObjectSerializer,
 	deleteObjectDeserializer,
-	{ ...defaultConfig, responseType: 'text' }
+	{ ...defaultConfig, responseType: 'text' },
 );

package/src/providers/s3/utils/client/getObject.ts

@@ -2,14 +2,14 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import {
+	EMPTY_SHA256_HASH,
 	Endpoint,
 	HttpRequest,
+	HttpResponse,
+	PresignUrlOptions,
+	UserAgentOptions,
 	parseMetadata,
 	presignUrl,
-	UserAgentOptions,
-	PresignUrlOptions,
-	EMPTY_SHA256_HASH,
-	HttpResponse,
 } from '@aws-amplify/core/internals/aws-client-utils';
 import { AmplifyUrl } from '@aws-amplify/core/internals/utils';
 import { composeServiceApi } from '@aws-amplify/core/internals/aws-client-utils/composers';
@@ -21,6 +21,7 @@ import type {
 	GetObjectCommandOutput,
 } from './types';
 import {
+	CONTENT_SHA256_HEADER,
 	buildStorageServiceError,
 	deserializeBoolean,
 	deserializeMetadata,
@@ -30,7 +31,6 @@ import {
 	parseXmlError,
 	s3TransferHandler,
 	serializePathnameObjectKey,
-	CONTENT_SHA256_HEADER,
 	validateS3RequiredParameter,
 } from './utils';
 
@@ -45,11 +45,12 @@ export type GetObjectOutput = GetObjectCommandOutput;
 
 const getObjectSerializer = async (
 	input: GetObjectInput,
-	endpoint: Endpoint
+	endpoint: Endpoint,
 ): Promise<HttpRequest> => {
 	const url = new AmplifyUrl(endpoint.url.toString());
 	validateS3RequiredParameter(!!input.Key, 'Key');
 	url.pathname = serializePathnameObjectKey(url, input.Key);
+
 	return {
 		method: 'GET',
 		headers: {
@@ -60,7 +61,7 @@ const getObjectSerializer = async (
 };
 
 const getObjectDeserializer = async (
-	response: HttpResponse
+	response: HttpResponse,
 ): Promise<GetObjectOutput> => {
 	if (response.statusCode >= 300) {
 		const error = (await parseXmlError(response)) as Error;
@@ -122,7 +123,7 @@ export const getObject = composeServiceApi(
 	s3TransferHandler,
 	getObjectSerializer,
 	getObjectDeserializer,
-	{ ...defaultConfig, responseType: 'blob' }
+	{ ...defaultConfig, responseType: 'blob' },
 );
 
 type S3GetObjectPresignedUrlConfig = Omit<
@@ -140,7 +141,7 @@ type S3GetObjectPresignedUrlConfig = Omit<
  */
 export const getPresignedGetObjectUrl = async (
 	config: S3GetObjectPresignedUrlConfig,
-	input: GetObjectInput
+	input: GetObjectInput,
 ): Promise<URL> => {
 	const endpoint = defaultConfig.endpointResolver(config, input);
 	const { url, headers, method } = await getObjectSerializer(input, endpoint);
@@ -152,15 +153,16 @@ export const getPresignedGetObjectUrl = async (
 	if (config.userAgentValue) {
 		url.searchParams.append(
 			config.userAgentHeader ?? USER_AGENT_HEADER,
-			config.userAgentValue
+			config.userAgentValue,
 		);
 	}
 
 	for (const [headerName, value] of Object.entries(headers).sort(
-		([key1], [key2]) => key1.localeCompare(key2)
+		([key1], [key2]) => key1.localeCompare(key2),
 	)) {
 		url.searchParams.append(headerName, value);
 	}
+
 	return presignUrl(
 		{ method, url, body: undefined },
 		{
@@ -168,6 +170,6 @@ export const getPresignedGetObjectUrl = async (
 			signingRegion: config.region,
 			...defaultConfig,
 			...config,
-		}
+		},
 	);
 };

package/src/providers/s3/utils/client/headObject.ts

@@ -9,9 +9,9 @@ import {
 } from '@aws-amplify/core/internals/aws-client-utils';
 import { AmplifyUrl } from '@aws-amplify/core/internals/utils';
 import { composeServiceApi } from '@aws-amplify/core/internals/aws-client-utils/composers';
+
 import { defaultConfig } from './base';
 import type { HeadObjectCommandInput, HeadObjectCommandOutput } from './types';
-
 import {
 	buildStorageServiceError,
 	deserializeMetadata,
@@ -23,7 +23,6 @@ import {
 	serializePathnameObjectKey,
 	validateS3RequiredParameter,
 } from './utils';
-import { StorageError } from '../../../../errors/StorageError';
 
 export type HeadObjectInput = Pick<HeadObjectCommandInput, 'Bucket' | 'Key'>;
 
@@ -40,11 +39,12 @@ export type HeadObjectOutput = Pick<
 
 const headObjectSerializer = async (
 	input: HeadObjectInput,
-	endpoint: Endpoint
+	endpoint: Endpoint,
 ): Promise<HttpRequest> => {
 	const url = new AmplifyUrl(endpoint.url.toString());
 	validateS3RequiredParameter(!!input.Key, 'Key');
 	url.pathname = serializePathnameObjectKey(url, input.Key);
+
 	return {
 		method: 'HEAD',
 		headers: {},
@@ -53,7 +53,7 @@ const headObjectSerializer = async (
 };
 
 const headObjectDeserializer = async (
-	response: HttpResponse
+	response: HttpResponse,
 ): Promise<HeadObjectOutput> => {
 	if (response.statusCode >= 300) {
 		// error is always set when statusCode >= 300
@@ -70,6 +70,7 @@ const headObjectDeserializer = async (
 			}),
 			Metadata: deserializeMetadata(response.headers),
 		};
+
 		return {
 			$metadata: parseMetadata(response),
 			...contents,
@@ -81,5 +82,5 @@ export const headObject = composeServiceApi(
 	s3TransferHandler,
 	headObjectSerializer,
 	headObjectDeserializer,
-	{ ...defaultConfig, responseType: 'text' }
+	{ ...defaultConfig, responseType: 'text' },
 );

package/src/providers/s3/utils/client/listObjectsV2.ts

@@ -12,6 +12,7 @@ import {
 	AmplifyUrlSearchParams,
 } from '@aws-amplify/core/internals/utils';
 import { composeServiceApi } from '@aws-amplify/core/internals/aws-client-utils/composers';
+
 import type {
 	ListObjectsV2CommandInput,
 	ListObjectsV2CommandOutput,
@@ -36,7 +37,7 @@ export type ListObjectsV2Output = ListObjectsV2CommandOutput;
 
 const listObjectsV2Serializer = (
 	input: ListObjectsV2Input,
-	endpoint: Endpoint
+	endpoint: Endpoint,
 ): HttpRequest => {
 	const headers = assignStringVariables({
 		'x-amz-request-payer': input.RequestPayer,
@@ -54,6 +55,7 @@ const listObjectsV2Serializer = (
 	});
 	const url = new AmplifyUrl(endpoint.url.toString());
 	url.search = new AmplifyUrlSearchParams(query).toString();
+
 	return {
 		method: 'GET',
 		headers,
@@ -62,7 +64,7 @@ const listObjectsV2Serializer = (
 };
 
 const listObjectsV2Deserializer = async (
-	response: HttpResponse
+	response: HttpResponse,
 ): Promise<ListObjectsV2Output> => {
 	if (response.statusCode >= 300) {
 		// error is always set when statusCode >= 300
@@ -90,6 +92,7 @@ const listObjectsV2Deserializer = async (
 			Prefix: 'Prefix',
 			StartAfter: 'StartAfter',
 		});
+
 		return {
 			$metadata: parseMetadata(response),
 			...contents,
@@ -131,5 +134,5 @@ export const listObjectsV2 = composeServiceApi(
 	s3TransferHandler,
 	listObjectsV2Serializer,
 	listObjectsV2Deserializer,
-	{ ...defaultConfig, responseType: 'text' }
+	{ ...defaultConfig, responseType: 'text' },
 );