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

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

@@ -48,9 +48,9 @@ type InferInstructionResultType<T extends Instruction<any>> =
  *
  * @internal
  */
-export const map = <Instructions extends { [key: string]: Instruction<any> }>(
+export const map = <Instructions extends Record<string, Instruction<any>>>(
 	obj: Record<string, any>,
-	instructions: Instructions
+	instructions: Instructions,
 ): {
 	[K in keyof Instructions]: InferInstructionResultType<Instructions[K]>;
 } => {
@@ -59,12 +59,13 @@ export const map = <Instructions extends { [key: string]: Instruction<any> }>(
 		const [accessor, deserializer] = Array.isArray(instruction)
 			? instruction
 			: [instruction];
-		if (obj.hasOwnProperty(accessor)) {
+		if (Object.prototype.hasOwnProperty.call(obj, accessor)) {
 			result[key as keyof Instructions] = deserializer
 				? deserializer(obj[accessor])
 				: String(obj[accessor]);
 		}
 	}
+
 	return result;
 };
 
@@ -108,16 +109,17 @@ export const deserializeTimestamp = (value: string): Date | undefined => {
  *
  * @internal
  */
-export const emptyArrayGuard = <T extends Array<any>>(
+export const emptyArrayGuard = <T extends any[]>(
 	value: any,
-	deserializer: (value: any[]) => T
+	deserializer: (value: any[]) => T,
 ): T => {
 	if (value === '') {
 		return [] as any as T;
 	}
 	const valueArray = (Array.isArray(value) ? value : [value]).filter(
-		e => e != null
+		e => e != null,
 	);
+
 	return deserializer(valueArray);
 };
 
@@ -125,15 +127,17 @@ export const emptyArrayGuard = <T extends Array<any>>(
  * @internal
  */
 export const deserializeMetadata = (
-	headers: Headers
+	headers: Headers,
 ): Record<string, string> => {
 	const objectMetadataHeaderPrefix = 'x-amz-meta-';
 	const deserialized = Object.keys(headers)
 		.filter(header => header.startsWith(objectMetadataHeaderPrefix))
 		.reduce((acc, header) => {
 			acc[header.replace(objectMetadataHeaderPrefix, '')] = headers[header];
+
 			return acc;
 		}, {} as any);
+
 	return Object.keys(deserialized).length > 0 ? deserialized : undefined;
 };
 
@@ -144,7 +148,7 @@ export const deserializeMetadata = (
  */
 export const buildStorageServiceError = (
 	error: Error,
-	statusCode: number
+	statusCode: number,
 ): ServiceError => {
 	const storageError = new StorageError({
 		name: error.name,
@@ -154,5 +158,6 @@ export const buildStorageServiceError = (
 		storageError.recoverySuggestion =
 			'Please add the object with this key to the bucket as the key is not found.';
 	}
+
 	return storageError;
 };

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

@@ -15,13 +15,14 @@ export const parseXmlError: ErrorParser = async (response?: HttpResponse) => {
 	}
 	const { statusCode } = response;
 	const body = await parseXmlBody(response);
-	const code = body?.['Code']
+	const code = body?.Code
 		? (body.Code as string)
 		: statusCode === 404
-		  ? 'NotFound'
-		  : statusCode.toString();
-	const message = body?.['message'] ?? body?.['Message'] ?? code;
+			? 'NotFound'
+			: statusCode.toString();
+	const message = body?.message ?? body?.Message ?? code;
 	const error = new Error(message);
+
 	return Object.assign(error, {
 		name: code,
 		$metadata: parseMetadata(response),
@@ -41,5 +42,6 @@ export const parseXmlBody = async (response: HttpResponse): Promise<any> => {
 			throw new Error('Failed to parse XML response.');
 		}
 	}
+
 	return {};
 };

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

@@ -2,13 +2,14 @@
 // SPDX-License-Identifier: Apache-2.0
 import { extendedEncodeURIComponent } from '@aws-amplify/core/internals/aws-client-utils';
 import { AmplifyErrorCode } from '@aws-amplify/core/internals/utils';
+
 import { StorageError } from '../../../../../errors/StorageError';
 
 /**
  * @internal
  */
 export const assignStringVariables = (
-	values: Record<string, { toString: () => string } | undefined>
+	values: Record<string, { toString(): string } | undefined>,
 ): Record<string, string> => {
 	const queryParams: Record<string, string> = {};
 	for (const [key, value] of Object.entries(values)) {
@@ -16,6 +17,7 @@ export const assignStringVariables = (
 			queryParams[key] = value.toString();
 		}
 	}
+
 	return queryParams;
 };
 
@@ -39,7 +41,7 @@ interface ObjectConfigs {
  * @internal
  */
 export const serializeObjectConfigsToHeaders = async (
-	input: ObjectConfigs
+	input: ObjectConfigs,
 ) => ({
 	...assignStringVariables({
 		'x-amz-acl': input.ACL,
@@ -55,10 +57,11 @@ export const serializeObjectConfigsToHeaders = async (
 });
 
 const serializeMetadata = (
-	metadata: Record<string, string> = {}
+	metadata: Record<string, string> = {},
 ): Record<string, string> =>
 	Object.keys(metadata).reduce((acc: any, suffix: string) => {
 		acc[`x-amz-meta-${suffix.toLowerCase()}`] = metadata[suffix];
+
 		return acc;
 	}, {});
 
@@ -77,14 +80,14 @@ export const serializePathnameObjectKey = (url: URL, key: string) => {
 
 export function validateS3RequiredParameter(
 	assertion: boolean,
-	paramName: string
+	paramName: string,
 ): asserts assertion {
 	if (!assertion) {
 		throw new StorageError({
 			name: AmplifyErrorCode.Unknown,
 			message: 'An unknown error has occurred.',
 			underlyingError: new TypeError(
-				`Expected a non-null value for S3 parameter ${paramName}`
+				`Expected a non-null value for S3 parameter ${paramName}`,
 			),
 			recoverySuggestion:
 				'This is likely to be a bug. Please reach out to library authors.',

package/src/providers/s3/utils/md5.native.ts

@@ -2,10 +2,11 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { Md5 } from '@smithy/md5-js';
+
 import { toBase64 } from './client/utils';
 
 export const calculateContentMd5 = async (
-	content: Blob | string | ArrayBuffer | ArrayBufferView
+	content: Blob | string | ArrayBuffer | ArrayBufferView,
 ): Promise<string> => {
 	const hasher = new Md5();
 	if (typeof content === 'string') {
@@ -19,6 +20,7 @@ export const calculateContentMd5 = async (
 		hasher.update(buffer);
 	}
 	const digest = await hasher.digest();
+
 	return toBase64(digest);
 };
 
@@ -29,8 +31,12 @@ const readFile = (file: Blob): Promise<ArrayBuffer> => {
 			if (reader.result) {
 				resolve(reader.result as ArrayBuffer);
 			}
-			reader.onabort = () => reject(new Error('Read aborted'));
-			reader.onerror = () => reject(reader.error);
+			reader.onabort = () => {
+				reject(new Error('Read aborted'));
+			};
+			reader.onerror = () => {
+				reject(reader.error);
+			};
 		};
 		if (file !== undefined) reader.readAsArrayBuffer(file);
 	});

package/src/providers/s3/utils/md5.ts

@@ -2,10 +2,11 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { Md5 } from '@smithy/md5-js';
+
 import { toBase64, utf8Encode } from './client/utils';
 
 export const calculateContentMd5 = async (
-	content: Blob | string | ArrayBuffer | ArrayBufferView
+	content: Blob | string | ArrayBuffer | ArrayBufferView,
 ): Promise<string> => {
 	const hasher = new Md5();
 	if (typeof content === 'string') {
@@ -19,6 +20,7 @@ export const calculateContentMd5 = async (
 		hasher.update(utf8Encode(buffer));
 	}
 	const digest = await hasher.digest();
+
 	return toBase64(digest);
 };
 
@@ -30,12 +32,18 @@ const readFileToBase64 = (blob: Blob): Promise<string> => {
 			// response from readAsDataURL is always prepended with "data:*/*;base64,"
 			// reference: https://developer.mozilla.org/en-US/docs/Web/API/FileReader/readyState
 			if (reader.readyState !== 2) {
-				return reject(new Error('Reader aborted too early'));
+				reject(new Error('Reader aborted too early'));
+
+				return;
 			}
 			resolve((reader.result as string).split(',')[1]);
 		};
-		reader.onabort = () => reject(new Error('Read aborted'));
-		reader.onerror = () => reject(reader.error);
+		reader.onabort = () => {
+			reject(new Error('Read aborted'));
+		};
+		reader.onerror = () => {
+			reject(reader.error);
+		};
 		// reader.readAsArrayBuffer is not available in RN
 		reader.readAsDataURL(blob);
 	});

package/src/providers/s3/utils/resolveS3ConfigAndInput.ts

@@ -2,25 +2,27 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { AmplifyClassV6, StorageAccessLevel } from '@aws-amplify/core';
+
 import { assertValidationError } from '../../../errors/utils/assertValidationError';
 import { StorageValidationErrorCode } from '../../../errors/types/validation';
 import { StorageError } from '../../../errors/StorageError';
-import { DEFAULT_ACCESS_LEVEL, LOCAL_TESTING_S3_ENDPOINT } from './constants';
 import { resolvePrefix as defaultPrefixResolver } from '../../../utils/resolvePrefix';
 import { ResolvedS3Config } from '../types/options';
 
-type S3ApiOptions = {
+import { DEFAULT_ACCESS_LEVEL, LOCAL_TESTING_S3_ENDPOINT } from './constants';
+
+interface S3ApiOptions {
 	accessLevel?: StorageAccessLevel;
 	targetIdentityId?: string;
 	useAccelerateEndpoint?: boolean;
-};
+}
 
-type ResolvedS3ConfigAndInput = {
+interface ResolvedS3ConfigAndInput {
 	s3Config: ResolvedS3Config;
 	bucket: string;
 	keyPrefix: string;
 	isObjectLockEnabled?: boolean;
-};
+}
 
 /**
  * resolve the common input options for S3 API handlers from Amplify configuration and library options.
@@ -35,7 +37,7 @@ type ResolvedS3ConfigAndInput = {
  */
 export const resolveS3ConfigAndInput = async (
 	amplify: AmplifyClassV6,
-	apiOptions?: S3ApiOptions
+	apiOptions?: S3ApiOptions,
 ): Promise<ResolvedS3ConfigAndInput> => {
 	// identityId is always cached in memory if forceRefresh is not set. So we can safely make calls here.
 	const { credentials, identityId } = await amplify.Auth.fetchAuthSession({
@@ -43,7 +45,7 @@ export const resolveS3ConfigAndInput = async (
 	});
 	assertValidationError(
 		!!credentials,
-		StorageValidationErrorCode.NoCredentials
+		StorageValidationErrorCode.NoCredentials,
 	);
 	assertValidationError(!!identityId, StorageValidationErrorCode.NoIdentityId);
 
@@ -77,7 +79,7 @@ export const resolveS3ConfigAndInput = async (
 				? {
 						customEndpoint: LOCAL_TESTING_S3_ENDPOINT,
 						forcePathStyle: true,
-				  }
+					}
 				: {}),
 		},
 		bucket,

package/src/providers/s3/utils/transferTask.ts

@@ -9,10 +9,10 @@ import {
 } from '../../../types/common';
 import { logger } from '../../../utils';
 
-type CreateCancellableTaskOptions<Result> = {
-	job: () => Promise<Result>;
-	onCancel: (message?: string) => void;
-};
+interface CreateCancellableTaskOptions<Result> {
+	job(): Promise<Result>;
+	onCancel(message?: string): void;
+}
 
 type CancellableTask<Result> = DownloadTask<Result>;
 
@@ -21,12 +21,17 @@ const createCancellableTask = <Result>({
 	onCancel,
 }: CreateCancellableTaskOptions<Result>): CancellableTask<Result> => {
 	const state = 'IN_PROGRESS' as TransferTaskState;
-	let canceledErrorMessage: string | undefined = undefined;
+	let canceledErrorMessage: string | undefined;
 	const cancelableTask = {
 		cancel: (message?: string) => {
-			const { state } = cancelableTask;
-			if (state === 'CANCELED' || state === 'ERROR' || state === 'SUCCESS') {
-				logger.debug(`This task cannot be canceled. State: ${state}`);
+			const { state: taskState } = cancelableTask;
+			if (
+				taskState === 'CANCELED' ||
+				taskState === 'ERROR' ||
+				taskState === 'SUCCESS'
+			) {
+				logger.debug(`This task cannot be canceled. State: ${taskState}`);
+
 				return;
 			}
 			cancelableTask.state = 'CANCELED';
@@ -40,6 +45,7 @@ const createCancellableTask = <Result>({
 		try {
 			const result = await job();
 			cancelableTask.state = 'SUCCESS';
+
 			return result;
 		} catch (e) {
 			if (isCancelError(e)) {
@@ -58,13 +64,13 @@ const createCancellableTask = <Result>({
 
 export const createDownloadTask = createCancellableTask;
 
-type CreateUploadTaskOptions<Result> = {
-	job: () => Promise<Result>;
-	onCancel: (message?: string) => void;
-	onResume?: () => void;
-	onPause?: () => void;
+interface CreateUploadTaskOptions<Result> {
+	job(): Promise<Result>;
+	onCancel(message?: string): void;
+	onResume?(): void;
+	onPause?(): void;
 	isMultipartUpload?: boolean;
-};
+}
 
 export const createUploadTask = <Result>({
 	job,
@@ -83,8 +89,11 @@ export const createUploadTask = <Result>({
 			const { state } = uploadTask;
 			if (!isMultipartUpload || state !== 'IN_PROGRESS') {
 				logger.debug(`This task cannot be paused. State: ${state}`);
+
 				return;
 			}
+			// TODO(eslint): remove this linter suppression.
+			// eslint-disable-next-line @typescript-eslint/ban-ts-comment
 			// @ts-ignore
 			uploadTask.state = 'PAUSED';
 			onPause?.();
@@ -93,8 +102,11 @@ export const createUploadTask = <Result>({
 			const { state } = uploadTask;
 			if (!isMultipartUpload || state !== 'PAUSED') {
 				logger.debug(`This task cannot be resumed. State: ${state}`);
+
 				return;
 			}
+			// TODO(eslint): remove this linter suppression.
+			// eslint-disable-next-line @typescript-eslint/ban-ts-comment
 			// @ts-ignore
 			uploadTask.state = 'IN_PROGRESS';
 			onResume?.();

package/src/providers/s3/utils/userAgent.ts

@@ -1,8 +1,8 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import {
-	StorageAction,
 	Category,
+	StorageAction,
 	getAmplifyUserAgent,
 } from '@aws-amplify/core/internals/utils';
 

package/src/types/common.ts

@@ -10,12 +10,12 @@ export type TransferTaskState =
 	| 'SUCCESS'
 	| 'ERROR';
 
-export type TransferProgressEvent = {
+export interface TransferProgressEvent {
 	transferredBytes: number;
 	totalBytes?: number;
-};
+}
 
-export type TransferTask<Result> = {
+export interface TransferTask<Result> {
 	/**
 	 * Cancel an ongoing transfer(upload/download) task. This will reject the `result` promise with an `AbortError` by
 	 * default. You can use `isCancelError` to check if the error is caused by cancellation.
@@ -24,19 +24,19 @@ export type TransferTask<Result> = {
 	 * 	canceled. If provided, the `result` promise will be rejected with a {@link CanceledError} with supplied error
 	 *  message instead.
 	 */
-	cancel: (message?: string) => void;
+	cancel(message?: string): void;
 
 	/**
 	 * Pause an ongoing transfer(upload/download) task. This method does not support the following scenarios:
 	 * * Downloading data or file from given key.
 	 */
-	pause: () => void;
+	pause(): void;
 
 	/**
 	 * Resume a paused transfer(upload/download) task. This method does not support the following scenarios:
 	 * * Downloading data or file from given key.
 	 */
-	resume: () => void;
+	resume(): void;
 
 	/**
 	 * Current state of the transfer task.
@@ -47,7 +47,7 @@ export type TransferTask<Result> = {
 	 * Promise that resolves when the transfer task is completed. The promise will be rejected if the task is canceled.
 	 */
 	result: Promise<Result>;
-};
+}
 
 export type DownloadTask<Result> = Omit<
 	TransferTask<Result>,

package/src/types/inputs.ts

@@ -2,30 +2,30 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import {
-	StorageOptions,
 	StorageListAllOptions,
 	StorageListPaginateOptions,
+	StorageOptions,
 } from './options';
 
-export type StorageOperationInput<Options extends StorageOptions> = {
+export interface StorageOperationInput<Options extends StorageOptions> {
 	key: string;
 	options?: Options;
-};
+}
 
 export type StorageGetPropertiesInput<Options extends StorageOptions> =
 	StorageOperationInput<Options>;
 
-export type StorageRemoveInput<Options extends StorageOptions> = {
+export interface StorageRemoveInput<Options extends StorageOptions> {
 	key: string;
 	options?: Options;
-};
+}
 
-export type StorageListInput<
+export interface StorageListInput<
 	Options extends StorageListAllOptions | StorageListPaginateOptions,
-> = {
+> {
 	prefix?: string;
 	options?: Options;
-};
+}
 
 export type StorageGetUrlInput<Options extends StorageOptions> =
 	StorageOperationInput<Options>;
@@ -38,13 +38,13 @@ export type StorageUploadDataInput<Options extends StorageOptions> =
 		data: StorageUploadDataPayload;
 	};
 
-export type StorageCopyInput<
+export interface StorageCopyInput<
 	SourceOptions extends StorageOptions,
 	DestinationOptions extends StorageOptions,
-> = {
+> {
 	source: SourceOptions;
 	destination: DestinationOptions;
-};
+}
 
 /**
  * The data payload type for upload operation.

package/src/types/options.ts

@@ -3,9 +3,9 @@
 
 import { StorageAccessLevel } from '@aws-amplify/core';
 
-export type StorageOptions = {
+export interface StorageOptions {
 	accessLevel?: StorageAccessLevel;
-};
+}
 
 export type StorageListAllOptions = StorageOptions & {
 	listAll: true;

package/src/types/outputs.ts

@@ -3,7 +3,7 @@
 
 import { ResponseBodyMixin } from '@aws-amplify/core/internals/aws-client-utils';
 
-export type StorageItem = {
+export interface StorageItem {
 	/**
 	 * Key of the object
 	 */
@@ -26,13 +26,13 @@ export type StorageItem = {
 	 * @see https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingMetadata.html#UserMetadata
 	 */
 	metadata?: Record<string, string>;
-};
+}
 
 export type StorageDownloadDataOutput<T extends StorageItem> = T & {
 	body: ResponseBodyMixin;
 };
 
-export type StorageGetUrlOutput = {
+export interface StorageGetUrlOutput {
 	/**
 	 * presigned URL of the given object.
 	 */
@@ -41,10 +41,10 @@ export type StorageGetUrlOutput = {
 	 * expiresAt is date in which generated URL expires.
 	 */
 	expiresAt: Date;
-};
+}
 
 export type StorageUploadOutput<Item extends StorageItem> = Item;
 
-export type StorageListOutput<Item extends StorageItem> = {
+export interface StorageListOutput<Item extends StorageItem> {
 	items: Item[];
-};
+}

package/src/utils/resolvePrefix.ts

@@ -2,13 +2,14 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { StorageAccessLevel } from '@aws-amplify/core';
+
 import { assertValidationError } from '../errors/utils/assertValidationError';
 import { StorageValidationErrorCode } from '../errors/types/validation';
 
-type ResolvePrefixOptions = {
+interface ResolvePrefixOptions {
 	accessLevel: StorageAccessLevel;
 	targetIdentityId?: string;
-};
+}
 
 export const resolvePrefix = ({
 	accessLevel,
@@ -17,14 +18,16 @@ export const resolvePrefix = ({
 	if (accessLevel === 'private') {
 		assertValidationError(
 			!!targetIdentityId,
-			StorageValidationErrorCode.NoIdentityId
+			StorageValidationErrorCode.NoIdentityId,
 		);
+
 		return `private/${targetIdentityId}/`;
 	} else if (accessLevel === 'protected') {
 		assertValidationError(
 			!!targetIdentityId,
-			StorageValidationErrorCode.NoIdentityId
+			StorageValidationErrorCode.NoIdentityId,
 		);
+
 		return `protected/${targetIdentityId}/`;
 	} else {
 		return 'public/';