delete objects initial implementation

Author: osama-rizk

packages/storage/src/index.ts

@@ -9,6 +9,7 @@ export {
 	getProperties,
 	copy,
 	getUrl,
+	removeObjects,
 } from './providers/s3';
 
 export {
@@ -18,6 +19,7 @@ export {
 	DownloadDataWithPathInput,
 	RemoveInput,
 	RemoveWithPathInput,
+	RemoveObjectsInput,
 	ListAllInput,
 	ListAllWithPathInput,
 	ListPaginateInput,
@@ -37,6 +39,7 @@ export {
 	DownloadDataWithPathOutput,
 	RemoveOutput,
 	RemoveWithPathOutput,
+	RemoveObjectsOutput,
 	ListAllOutput,
 	ListAllWithPathOutput,
 	ListPaginateOutput,

packages/storage/src/internals/apis/removeObjects.ts

@@ -0,0 +1,16 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { Amplify } from '@aws-amplify/core';
+
+import { removeObjects as removeObjectsInternal } from '../../providers/s3/apis/internal/removeObjects';
+import { RemoveObjectsInput } from '../types/inputs';
+import { RemoveObjectsOutput } from '../types/outputs';
+
+/**
+ * @internal
+ */
+export const removeObjects = (
+	input: RemoveObjectsInput,
+): Promise<RemoveObjectsOutput> =>
+	removeObjectsInternal(Amplify, input as any) as Promise<RemoveObjectsOutput>;

packages/storage/src/internals/index.ts

@@ -18,6 +18,7 @@ export {
 	ListAllInput,
 	ListPaginateInput,
 	RemoveInput,
+	RemoveObjectsInput,
 	UploadDataInput,
 	DownloadDataInput,
 } from './types/inputs';
@@ -27,6 +28,7 @@ export {
 	GetPropertiesOutput,
 	GetUrlOutput,
 	RemoveOutput,
+	RemoveObjectsOutput,
 	UploadDataOutput,
 	DownloadDataOutput,
 	ListOutput,
@@ -39,6 +41,7 @@ export { list } from './apis/list';
 export { getProperties } from './apis/getProperties';
 export { getUrl } from './apis/getUrl';
 export { remove } from './apis/remove';
+export { removeObjects } from './apis/removeObjects';
 export { uploadData } from './apis/uploadData';
 export { downloadData } from './apis/downloadData';
 export { copy } from './apis/copy';

packages/storage/src/internals/types/inputs.ts

@@ -13,6 +13,7 @@ import {
 	GetUrlWithPathInput,
 	ListAllWithPathInput,
 	ListPaginateWithPathInput,
+	RemoveObjectsInput as RemoveObjectsWithPathInput,
 	RemoveWithPathInput,
 	UploadDataWithPathInput,
 } from '../../providers/s3';
@@ -79,6 +80,14 @@ export type RemoveInput = ExtendInputWithAdvancedOptions<
 	AdvancedOptions
 >;
 
+/**
+ * @internal
+ */
+export type RemoveObjectsInput = ExtendInputWithAdvancedOptions<
+	RemoveObjectsWithPathInput,
+	AdvancedOptions
+>;
+
 /**
  * @internal
  */

packages/storage/src/internals/types/outputs.ts

@@ -8,6 +8,7 @@ import {
 	GetUrlWithPathOutput,
 	ListAllWithPathOutput,
 	ListPaginateWithPathOutput,
+	RemoveObjectsOutput as RemoveObjectsWithPathOutput,
 	RemoveWithPathOutput,
 	UploadDataWithPathOutput,
 } from '../../providers/s3/types';
@@ -44,6 +45,11 @@ export type GetUrlOutput = GetUrlWithPathOutput;
  */
 export type RemoveOutput = RemoveWithPathOutput;
 
+/**
+ * @internal
+ */
+export type RemoveObjectsOutput = RemoveObjectsWithPathOutput;
+
 /**
  * @internal
  */

packages/storage/src/providers/s3/apis/index.ts

@@ -4,6 +4,7 @@
 export { uploadData } from './uploadData';
 export { downloadData } from './downloadData';
 export { remove } from './remove';
+export { removeObjects } from './removeObjects';
 export { list } from './list';
 export { getProperties } from './getProperties';
 export { copy } from './copy';

packages/storage/src/providers/s3/apis/internal/removeObjects.ts

@@ -0,0 +1,76 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { AmplifyClassV6 } from '@aws-amplify/core';
+import { StorageAction } from '@aws-amplify/core/internals/utils';
+
+import { RemoveObjectsInput, RemoveObjectsOutput } from '../../types';
+import {
+	calculateContentMd5,
+	resolveS3ConfigAndInput,
+	validateBucketOwnerID,
+} from '../../utils';
+import { deleteObjects } from '../../utils/client/s3data';
+import { getStorageUserAgentValue } from '../../utils/userAgent';
+import { logger } from '../../../../utils';
+
+export const removeObjects = async (
+	amplify: AmplifyClassV6,
+	input: RemoveObjectsInput,
+): Promise<RemoveObjectsOutput> => {
+	// @ts-expect-error input type
+	const { s3Config, bucket } = await resolveS3ConfigAndInput(amplify, input);
+
+	validateBucketOwnerID(input.options?.expectedBucketOwner);
+
+	if (!input.paths || input.paths.length === 0) {
+		throw new Error('At least one path must be provided');
+	}
+
+	if (input.paths.length > 1000) {
+		throw new Error('Cannot delete more than 1000 objects in a single request');
+	}
+
+	logger.debug(
+		`removing ${input.paths.length} objects from bucket "${bucket}"`,
+	);
+
+	// Build XML body for MD5 calculation
+	const objects = input.paths
+		.map(path => `<Object><Key>${path}</Key></Object>`)
+		.join('');
+	const xmlBody = `<?xml version="1.0" encoding="UTF-8"?>
+<Delete xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
+	<Quiet>false</Quiet>
+	${objects}
+</Delete>`;
+
+	// Calculate Content-MD5 (required for DeleteObjects)
+	const contentMd5 = await calculateContentMd5(xmlBody);
+
+	const result = await deleteObjects(
+		{
+			...s3Config,
+			userAgentValue: getStorageUserAgentValue(StorageAction.Remove),
+		},
+		{
+			Bucket: bucket,
+			Delete: {
+				Objects: input.paths.map(path => ({ Key: path })),
+				Quiet: false,
+			},
+			ExpectedBucketOwner: input.options?.expectedBucketOwner,
+			ContentMD5: contentMd5,
+		},
+	);
+
+	return {
+		deleted: result.Deleted?.map(item => ({ path: item.Key! })) || [],
+		errors:
+			result.Errors?.map(error => ({
+				path: error.Key!,
+				code: error.Code!,
+				message: error.Message!,
+			})) || [],
+	};
+};

packages/storage/src/providers/s3/apis/removeObjects.ts

@@ -0,0 +1,22 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { Amplify } from '@aws-amplify/core';
+
+import { RemoveObjectsInput, RemoveObjectsOutput } from '../types';
+
+import { removeObjects as removeObjectsInternal } from './internal/removeObjects';
+
+/**
+ * Remove multiple files from your S3 bucket in a single request.
+ * @param input - The `RemoveObjectsInput` object containing paths to remove.
+ * @return Output containing the removed object paths and any errors.
+ * @throws service: `S3Exception` - S3 service errors thrown while removing objects.
+ * @throws validation: `StorageValidationErrorCode` - Validation errors thrown
+ * when there are no paths or paths are empty.
+ */
+export function removeObjects(
+	input: RemoveObjectsInput,
+): Promise<RemoveObjectsOutput> {
+	return removeObjectsInternal(Amplify, input);
+}

packages/storage/src/providers/s3/index.ts

@@ -9,6 +9,7 @@ export {
 	getProperties,
 	copy,
 	getUrl,
+	removeObjects,
 } from './apis';
 
 export {
@@ -18,6 +19,7 @@ export {
 	DownloadDataWithPathInput,
 	RemoveInput,
 	RemoveWithPathInput,
+	RemoveObjectsInput,
 	ListAllInput,
 	ListAllWithPathInput,
 	ListPaginateInput,
@@ -37,6 +39,7 @@ export {
 	DownloadDataWithPathOutput,
 	RemoveOutput,
 	RemoveWithPathOutput,
+	RemoveObjectsOutput,
 	ListAllOutput,
 	ListAllWithPathOutput,
 	ListPaginateOutput,

packages/storage/src/providers/s3/types/index.ts

@@ -25,6 +25,7 @@ export {
 	DownloadDataWithPathOutput,
 	RemoveOutput,
 	RemoveWithPathOutput,
+	RemoveObjectsOutput,
 	ListAllOutput,
 	ListAllWithPathOutput,
 	ListPaginateOutput,
@@ -47,6 +48,7 @@ export {
 	GetUrlWithPathInput,
 	RemoveWithPathInput,
 	RemoveInput,
+	RemoveObjectsInput,
 	DownloadDataInput,
 	DownloadDataWithPathInput,
 	UploadDataInput,