@aws-amplify/storage 6.11.2-unstable.a361dd1.0 → 6.11.2-unstable.b6d4c7a.0

package/dist/esm/types/common.d.ts

@@ -32,5 +32,8 @@ export interface TransferTask<Result> {
      */
     result: Promise<Result>;
 }
+export interface NonPausableTransferTask<T> extends Omit<TransferTask<T>, 'pause' | 'resume' | 'state'> {
+    state: Omit<TransferTask<T>['state'], 'PAUSED'>;
+}
 export type DownloadTask<Result> = Omit<TransferTask<Result>, 'pause' | 'resume'>;
 export type UploadTask<Result> = TransferTask<Result>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/storage",
-  "version": "6.11.2-unstable.a361dd1.0+a361dd1",
+  "version": "6.11.2-unstable.b6d4c7a.0+b6d4c7a",
   "description": "Storage category of aws-amplify",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.mjs",
@@ -108,12 +108,12 @@
     "./package.json": "./package.json"
   },
   "peerDependencies": {
-    "@aws-amplify/core": "6.15.2-unstable.a361dd1.0+a361dd1"
+    "@aws-amplify/core": "6.15.2-unstable.b6d4c7a.0+b6d4c7a"
   },
   "devDependencies": {
-    "@aws-amplify/core": "6.15.2-unstable.a361dd1.0+a361dd1",
-    "@aws-amplify/react-native": "1.3.3-unstable.a361dd1.0+a361dd1",
+    "@aws-amplify/core": "6.15.2-unstable.b6d4c7a.0+b6d4c7a",
+    "@aws-amplify/react-native": "1.3.3-unstable.b6d4c7a.0+b6d4c7a",
     "@types/node": "20.14.12"
   },
-  "gitHead": "a361dd19828f6af3e6021727d2bf707b30fbe4a7"
+  "gitHead": "b6d4c7ac976855f530b41e95f678e96867832a11"
 }

package/src/internals/apis/remove.ts

@@ -4,22 +4,29 @@
 import { Amplify } from '@aws-amplify/core';
 
 import { remove as removeInternal } from '../../providers/s3/apis/internal/remove';
+import { RemoveOperation } from '../../providers/s3/types';
 import { RemoveInput } from '../types/inputs';
 import { RemoveOutput } from '../types/outputs';
 
 /**
  * @internal
  */
-export const remove = (input: RemoveInput): Promise<RemoveOutput> =>
-	removeInternal(Amplify, {
-		path: input.path,
-		options: {
-			useAccelerateEndpoint: input?.options?.useAccelerateEndpoint,
-			bucket: input?.options?.bucket,
-			expectedBucketOwner: input?.options?.expectedBucketOwner,
-			locationCredentialsProvider: input?.options?.locationCredentialsProvider,
-			customEndpoint: input?.options?.customEndpoint,
+export const remove = (input: RemoveInput): RemoveOperation<RemoveOutput> => {
+	return removeInternal(
+		Amplify,
+		{
+			path: input.path,
+			options: {
+				useAccelerateEndpoint: input?.options?.useAccelerateEndpoint,
+				bucket: input?.options?.bucket,
+				expectedBucketOwner: input?.options?.expectedBucketOwner,
+				locationCredentialsProvider:
+					input?.options?.locationCredentialsProvider,
+				customEndpoint: input?.options?.customEndpoint,
+				onProgress: input?.options?.onProgress,
+			},
 		},
 		// Type casting is necessary because `removeInternal` supports both Gen1 and Gen2 signatures, but here
 		// given in input can only be Gen2 signature, the return can only ben Gen2 signature.
-	}) as Promise<RemoveOutput>;
+	) as RemoveOperation<RemoveOutput>;
+};

package/src/providers/s3/apis/internal/remove.ts

@@ -4,58 +4,113 @@
 import { AmplifyClassV6 } from '@aws-amplify/core';
 import { StorageAction } from '@aws-amplify/core/internals/utils';
 
-import { RemoveInput, RemoveOutput, RemoveWithPathOutput } from '../../types';
 import {
+	RemoveInput,
+	RemoveOperation,
+	RemoveOutput,
+	RemoveWithPathOutput,
+} from '../../types';
+import {
+	deleteFolderContents,
+	isPathFolder,
+	resolveFinalKey,
 	resolveS3ConfigAndInput,
 	validateBucketOwnerID,
+	validateRemovePath,
 	validateStorageOperationInput,
 } from '../../utils';
 import { deleteObject } from '../../utils/client/s3data';
 import { getStorageUserAgentValue } from '../../utils/userAgent';
-import { logger } from '../../../../utils';
 import { STORAGE_INPUT_KEY } from '../../utils/constants';
+import { createAbortableTask } from '../../utils/createAbortableTask';
 // TODO: Remove this interface when we move to public advanced APIs.
 import { RemoveInput as RemoveWithPathInputWithAdvancedOptions } from '../../../../internals';
+import { CanceledError } from '../../../../errors/CanceledError';
 
-export const remove = async (
+export function remove(
+	amplify: AmplifyClassV6,
+	input: RemoveInput,
+): RemoveOperation<RemoveOutput>;
+export function remove(
+	amplify: AmplifyClassV6,
+	input: RemoveWithPathInputWithAdvancedOptions,
+): RemoveOperation<RemoveWithPathOutput>;
+export function remove(
 	amplify: AmplifyClassV6,
 	input: RemoveInput | RemoveWithPathInputWithAdvancedOptions,
-): Promise<RemoveOutput | RemoveWithPathOutput> => {
-	const { s3Config, keyPrefix, bucket, identityId } =
-		await resolveS3ConfigAndInput(amplify, input);
-
-	const { inputType, objectKey } = validateStorageOperationInput(
-		input,
-		identityId,
-	);
-	validateBucketOwnerID(input.options?.expectedBucketOwner);
-
-	let finalKey;
-	if (inputType === STORAGE_INPUT_KEY) {
-		finalKey = `${keyPrefix}${objectKey}`;
-		logger.debug(`remove "${objectKey}" from "${finalKey}".`);
-	} else {
-		finalKey = objectKey;
-		logger.debug(`removing object in path "${finalKey}"`);
-	}
-
-	await deleteObject(
-		{
-			...s3Config,
-			userAgentValue: getStorageUserAgentValue(StorageAction.Remove),
-		},
-		{
-			Bucket: bucket,
-			Key: finalKey,
-			ExpectedBucketOwner: input.options?.expectedBucketOwner,
-		},
-	);
-
-	return inputType === STORAGE_INPUT_KEY
-		? {
-				key: objectKey,
+): RemoveOperation<RemoveOutput | RemoveWithPathOutput> {
+	return createAbortableTask(executeRemove(amplify, input));
+}
+
+const executeRemove =
+	(
+		amplify: AmplifyClassV6,
+		input: RemoveInput | RemoveWithPathInputWithAdvancedOptions,
+	) =>
+	async (abortController: AbortController) => {
+		try {
+			const { s3Config, keyPrefix, bucket, identityId } =
+				await resolveS3ConfigAndInput(amplify, input);
+
+			const { inputType, objectKey } = validateStorageOperationInput(
+				input,
+				identityId,
+			);
+
+			validateBucketOwnerID(input.options?.expectedBucketOwner);
+
+			const finalKey = resolveFinalKey(inputType, objectKey, keyPrefix);
+
+			validateRemovePath(finalKey);
+
+			const isFolder =
+				finalKey.endsWith('/') ||
+				(await isPathFolder({
+					s3Config,
+					bucket,
+					key: finalKey,
+					expectedBucketOwner: input.options?.expectedBucketOwner,
+				}));
+
+			if (isFolder) {
+				return deleteFolderContents({
+					s3Config,
+					bucket,
+					folderKey: finalKey,
+					expectedBucketOwner: input.options?.expectedBucketOwner,
+					onProgress: (input as any).options?.onProgress,
+					abortSignal: abortController.signal,
+				});
+			} else {
+				if (abortController.signal.aborted) {
+					throw new CanceledError({ message: 'Operation was cancelled' });
+				}
+
+				await deleteObject(
+					{
+						...s3Config,
+						userAgentValue: getStorageUserAgentValue(StorageAction.Remove),
+						abortSignal: abortController.signal,
+					},
+					{
+						Bucket: bucket,
+						Key: finalKey,
+						ExpectedBucketOwner: input.options?.expectedBucketOwner,
+					},
+				);
+
+				const result =
+					inputType === STORAGE_INPUT_KEY
+						? { key: objectKey }
+						: { path: objectKey };
+
+				return result;
+			}
+		} catch (error) {
+			if (abortController.signal.aborted) {
+				throw new CanceledError({ message: 'Operation was cancelled' });
 			}
-		: {
-				path: objectKey,
-			};
-};
+
+			throw error;
+		}
+	};

package/src/providers/s3/apis/remove.ts

@@ -5,6 +5,7 @@ import { Amplify } from '@aws-amplify/core';
 
 import {
 	RemoveInput,
+	RemoveOperation,
 	RemoveOutput,
 	RemoveWithPathInput,
 	RemoveWithPathOutput,
@@ -13,29 +14,33 @@ import {
 import { remove as removeInternal } from './internal/remove';
 
 /**
- * Remove a file from your S3 bucket.
+ * Remove a file or folder from your S3 bucket.
  * @param input - The `RemoveWithPathInput` object.
- * @return Output containing the removed object path.
+ * @return Operation handle with result promise and cancellation capability.
  * @throws service: `S3Exception` - S3 service errors thrown while while removing the object.
  * @throws validation: `StorageValidationErrorCode` - Validation errors thrown
  * when there is no path or path is empty or path has a leading slash.
  */
 export function remove(
 	input: RemoveWithPathInput,
-): Promise<RemoveWithPathOutput>;
+): RemoveOperation<RemoveWithPathOutput>;
 /**
  * @deprecated The `key` and `accessLevel` parameters are deprecated and may be removed in the next major version.
  * Please use {@link https://docs.amplify.aws/react/build-a-backend/storage/remove | path} instead.
  *
  * Remove a file from your S3 bucket.
  * @param input - The `RemoveInput` object.
- * @return Output containing the removed object key
+ * @return Operation handle with result promise and cancellation capability.
  * @throws service: `S3Exception` - S3 service errors thrown while while removing the object
  * @throws validation: `StorageValidationErrorCode` - Validation errors thrown
  * when there is no key or its empty.
  */
-export function remove(input: RemoveInput): Promise<RemoveOutput>;
+export function remove(input: RemoveInput): RemoveOperation<RemoveOutput>;
 
 export function remove(input: RemoveInput | RemoveWithPathInput) {
-	return removeInternal(Amplify, input);
+	if ('key' in input) {
+		return removeInternal(Amplify, input);
+	} else {
+		return removeInternal(Amplify, input);
+	}
 }

package/src/providers/s3/apis/server/remove.ts

@@ -8,6 +8,7 @@ import {
 
 import {
 	RemoveInput,
+	RemoveOperation,
 	RemoveOutput,
 	RemoveWithPathInput,
 	RemoveWithPathOutput,
@@ -15,10 +16,10 @@ import {
 import { remove as removeInternal } from '../internal/remove';
 
 /**
- * Remove a file from your S3 bucket.
+ * Remove a file or folder from your S3 bucket.
  * @param input - The `RemoveWithPathInput` object.
  * @param contextSpec - The context spec used to get the Amplify server context.
- * @return Output containing the removed object path.
+ * @return Operation handle with result promise and cancellation capability.
  * @throws service: `S3Exception` - S3 service errors thrown while while removing the object.
  * @throws validation: `StorageValidationErrorCode` - Validation errors thrown
  * when there is no path or path is empty or path has a leading slash.
@@ -26,7 +27,7 @@ import { remove as removeInternal } from '../internal/remove';
 export function remove(
 	contextSpec: AmplifyServer.ContextSpec,
 	input: RemoveWithPathInput,
-): Promise<RemoveWithPathOutput>;
+): RemoveOperation<RemoveWithPathOutput>;
 /**
  * @deprecated The `key` and `accessLevel` parameters are deprecated and may be removed in the next major version.
  * Please use {@link https://docs.amplify.aws/react/build-a-backend/storage/remove | path} instead.
@@ -34,7 +35,7 @@ export function remove(
  * Remove a file from your S3 bucket.
  * @param input - The `RemoveInput` object.
  * @param contextSpec - The context spec used to get the Amplify server context.
- * @return Output containing the removed object key
+ * @return Operation handle with result promise and cancellation capability.
  * @throws service: `S3Exception` - S3 service errors thrown while while removing the object
  * @throws validation: `StorageValidationErrorCode` - Validation errors thrown
  * when there is no key or its empty.
@@ -42,11 +43,15 @@ export function remove(
 export function remove(
 	contextSpec: AmplifyServer.ContextSpec,
 	input: RemoveInput,
-): Promise<RemoveOutput>;
+): RemoveOperation<RemoveOutput>;
 
 export function remove(
 	contextSpec: AmplifyServer.ContextSpec,
 	input: RemoveInput | RemoveWithPathInput,
 ) {
-	return removeInternal(getAmplifyServerContext(contextSpec).amplify, input);
+	if ('key' in input) {
+		return removeInternal(getAmplifyServerContext(contextSpec).amplify, input);
+	} else {
+		return removeInternal(getAmplifyServerContext(contextSpec).amplify, input);
+	}
 }

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

@@ -47,6 +47,8 @@ export {
 	GetUrlWithPathInput,
 	RemoveWithPathInput,
 	RemoveInput,
+	RemoveOperation,
+	ProgressInfo,
 	DownloadDataInput,
 	DownloadDataWithPathInput,
 	UploadDataInput,

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

@@ -17,6 +17,7 @@ import {
 	StorageUploadDataInputWithKey,
 	StorageUploadDataInputWithPath,
 } from '../../../types';
+import { NonPausableTransferTask } from '../../../types/common';
 import {
 	CopyDestinationWithKeyOptions,
 	CopySourceWithKeyOptions,
@@ -107,9 +108,31 @@ export type RemoveInput = StorageRemoveInputWithKey<RemoveOptions>;
  * Input type with path for S3 remove API.
  */
 export type RemoveWithPathInput = StorageRemoveInputWithPath<
-	Omit<RemoveOptions, 'accessLevel'>
+	Omit<RemoveOptions, 'accessLevel'> & {
+		/** Callback function invoked after each batch completes, providing progress updates with file counts and error details. */
+		onProgress?(progress: ProgressInfo): void;
+	}
 >;
 
+/**
+ * Represents an ongoing remove operation with cancellation and state tracking capabilities
+ * @template T - The type of the result (RemoveWithPathOutput | RemoveOutput)
+ */
+export interface RemoveOperation<T> extends NonPausableTransferTask<T> {
+	then: Promise<T>['then'];
+	catch: Promise<T>['catch'];
+	finally: Promise<T>['finally'];
+}
+
+export interface ProgressInfo {
+	deleted?: { path: string }[];
+	failed?: {
+		path: string;
+		code: string;
+		message: string;
+	}[];
+}
+
 /**
  * @deprecated Use {@link DownloadDataWithPathInput} instead.
  * Input type for S3 downloadData API.

package/src/providers/s3/utils/client/s3data/deleteObjects.ts

@@ -0,0 +1,122 @@
+// 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,
+	s3TransferHandler,
+	validateS3RequiredParameter,
+} from '../utils';
+import { generateDeleteObjectsXml } from '../../generateDeleteObjectsXml';
+import { calculateContentMd5 } from '../../md5';
+
+import type {
+	DeleteObjectsCommandInput,
+	DeleteObjectsCommandOutput,
+} from './types';
+import { defaultConfig, parseXmlError } from './base';
+
+export type DeleteObjectsInput = Pick<
+	DeleteObjectsCommandInput,
+	'Bucket' | 'Delete' | 'ExpectedBucketOwner'
+> & {
+	ContentMD5?: string;
+};
+
+export type DeleteObjectsOutput = DeleteObjectsCommandOutput;
+
+const deleteObjectsSerializer = async (
+	input: DeleteObjectsInput,
+	endpoint: Endpoint,
+): Promise<HttpRequest> => {
+	const url = new AmplifyUrl(endpoint.url.toString());
+	validateS3RequiredParameter(!!input.Delete, 'Delete');
+	url.pathname = '/';
+	url.search = new AmplifyUrlSearchParams({
+		delete: '',
+	}).toString();
+
+	const body = generateDeleteObjectsXml(
+		input.Delete!.Objects,
+		input.Delete!.Quiet ?? false,
+	);
+
+	const contentMd5 = input.ContentMD5 ?? (await calculateContentMd5(body));
+
+	const headers = assignStringVariables({
+		'x-amz-expected-bucket-owner': input.ExpectedBucketOwner,
+		'content-type': 'application/xml',
+		'content-md5': contentMd5,
+	});
+
+	const request = {
+		method: 'POST',
+		headers,
+		url,
+		body,
+	};
+
+	return request;
+};
+
+const deleteObjectsDeserializer = async (
+	response: HttpResponse,
+): Promise<DeleteObjectsOutput> => {
+	if (response.statusCode >= 300) {
+		const error = await parseXmlError(response);
+		throw buildStorageServiceError(error!);
+	}
+
+	const text = await response.body.text();
+
+	const deleted: { Key?: string }[] = [];
+	const errors: { Key?: string; Code?: string; Message?: string }[] = [];
+
+	const deletedMatches = text.matchAll(/<Deleted>[\s\S]*?<\/Deleted>/g);
+	for (const match of deletedMatches) {
+		const keyMatch = match[0].match(/<Key>(.*?)<\/Key>/);
+		if (keyMatch) {
+			deleted.push({ Key: keyMatch[1] });
+		}
+	}
+
+	const errorMatches = text.matchAll(/<Error>[\s\S]*?<\/Error>/g);
+	for (const match of errorMatches) {
+		const keyMatch = match[0].match(/<Key>(.*?)<\/Key>/);
+		const codeMatch = match[0].match(/<Code>(.*?)<\/Code>/);
+		const messageMatch = match[0].match(/<Message>(.*?)<\/Message>/);
+
+		errors.push({
+			Key: keyMatch?.[1],
+			Code: codeMatch?.[1],
+			Message: messageMatch?.[1],
+		});
+	}
+
+	const result = {
+		Deleted: deleted,
+		Errors: errors,
+		$metadata: parseMetadata(response),
+	};
+
+	return result;
+};
+
+export const deleteObjects = composeServiceApi(
+	s3TransferHandler,
+	deleteObjectsSerializer,
+	deleteObjectsDeserializer,
+	{ ...defaultConfig, responseType: 'text' },
+);

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

@@ -38,4 +38,9 @@ export {
 	DeleteObjectInput,
 	DeleteObjectOutput,
 } from './deleteObject';
+export {
+	deleteObjects,
+	DeleteObjectsInput,
+	DeleteObjectsOutput,
+} from './deleteObjects';
 export { CompletedPart, Part, _Object } from './types';

package/src/providers/s3/utils/client/s3data/types.ts

@@ -5452,4 +5452,24 @@ export type StorageClass = (typeof StorageClass)[keyof typeof StorageClass];
 export type TaggingDirective =
 	(typeof TaggingDirective)[keyof typeof TaggingDirective];
 
+/**
+ * @public
+ */
+export interface DeleteObjectsCommandInput {
+	Bucket: string;
+	Delete: {
+		Objects: Array<{ Key: string }>;
+		Quiet?: boolean;
+	};
+	ExpectedBucketOwner?: string;
+}
+
+/**
+ * @public
+ */
+export interface DeleteObjectsCommandOutput extends __MetadataBearer {
+	Deleted?: Array<{ Key?: string }>;
+	Errors?: Array<{ Key?: string; Code?: string; Message?: string }>;
+}
+
 export {};

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

@@ -0,0 +1,45 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { NonPausableTransferTask } from '../../../types/common';
+
+export function createAbortableTask<T>(
+	executor: (abortController: AbortController) => Promise<T>,
+): NonPausableTransferTask<T> & {
+	then: Promise<T>['then'];
+	catch: Promise<T>['catch'];
+	finally: Promise<T>['finally'];
+} {
+	const abortController = new AbortController();
+	let state: NonPausableTransferTask<T>['state'] = 'IN_PROGRESS';
+
+	const resultPromise = executor(abortController);
+
+	const wrappedPromise = resultPromise
+		.then(result => {
+			state = 'SUCCESS';
+
+			return result;
+		})
+		.catch(error => {
+			state = abortController.signal.aborted ? 'CANCELED' : 'ERROR';
+
+			throw error;
+		});
+
+	const operation = {
+		result: wrappedPromise,
+		cancel: () => {
+			abortController.abort();
+			state = 'CANCELED';
+		},
+		get state() {
+			return state;
+		},
+		then: wrappedPromise.then.bind(wrappedPromise),
+		catch: wrappedPromise.catch.bind(wrappedPromise),
+		finally: wrappedPromise.finally.bind(wrappedPromise),
+	};
+
+	return operation;
+}