feat(storage): add PUT method support for getUrl presigned upload URLs

Author: osama-rizk

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

@@ -25,6 +25,7 @@ export const getUrl = (input: GetUrlInput) =>
 			// Advanced options
 			locationCredentialsProvider: input?.options?.locationCredentialsProvider,
 			customEndpoint: input?.options?.customEndpoint,
+			method: input?.options?.method,
 		},
 		// Type casting is necessary because `getPropertiesInternal` supports both Gen1 and Gen2 signatures, but here
 		// given in input can only be Gen2 signature, the return can only ben Gen2 signature.

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

@@ -13,7 +13,7 @@ import {
 import { getUrl as getUrlInternal } from './internal/getUrl';
 
 /**
- * Get a temporary presigned URL to download the specified S3 object.
+ * Get a temporary presigned URL to download or upload the specified S3 object.
  * The presigned URL expires when the associated role used to sign the request expires or
  * the option  `expiresIn` is reached. The `expiresAt` property in the output object indicates when the URL MAY expire.
  *

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

@@ -6,7 +6,10 @@ import { StorageAction } from '@aws-amplify/core/internals/utils';
 
 import { GetUrlInput, GetUrlOutput, GetUrlWithPathOutput } from '../../types';
 import { StorageValidationErrorCode } from '../../../../errors/types/validation';
-import { getPresignedGetObjectUrl } from '../../utils/client/s3data';
+import {
+	getPresignedGetObjectUrl,
+	getPresignedPutObjectUrl,
+} from '../../utils/client/s3data';
 import {
 	resolveS3ConfigAndInput,
 	validateBucketOwnerID,
@@ -39,8 +42,12 @@ export const getUrl = async (
 
 	const finalKey =
 		inputType === STORAGE_INPUT_KEY ? keyPrefix + objectKey : objectKey;
+	const operation = getUrlOptions?.method ?? 'GET';
 
-	if (getUrlOptions?.validateObjectExistence) {
+	if (
+		getUrlOptions?.validateObjectExistence &&
+		getUrlOptions?.method !== 'PUT'
+	) {
 		await getProperties(amplify, input, StorageAction.GetUrl);
 	}
 
@@ -63,7 +70,34 @@ export const getUrl = async (
 		StorageValidationErrorCode.UrlExpirationMaxLimitExceed,
 	);
 
-	// expiresAt is the minimum of credential expiration and url expiration
+	if (operation === 'PUT') {
+		return {
+			url: await getPresignedPutObjectUrl(
+				{
+					...s3Config,
+					credentials: resolvedCredential,
+					expiration: urlExpirationInSec,
+				},
+				{
+					Bucket: bucket,
+					Key: finalKey,
+					...(getUrlOptions?.contentType && {
+						ContentType: getUrlOptions.contentType,
+					}),
+					...(getUrlOptions?.contentDisposition && {
+						ContentDisposition:
+							typeof getUrlOptions.contentDisposition === 'string'
+								? getUrlOptions.contentDisposition
+								: constructContentDisposition(getUrlOptions.contentDisposition),
+					}),
+					CacheControl: getUrlOptions?.cacheControl,
+					ExpectedBucketOwner: getUrlOptions?.expectedBucketOwner,
+				},
+			),
+			expiresAt: new Date(Date.now() + urlExpirationInSec * 1000),
+		};
+	}
+
 	return {
 		url: await getPresignedGetObjectUrl(
 			{

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

@@ -158,6 +158,11 @@ export type ListPaginateWithPathOptions = Omit<
  * Input options type for S3 getUrl API.
  */
 export type GetUrlOptions = CommonOptions & {
+	/**
+	 * The HTTP method for the presigned URL.
+	 * @default 'GET'
+	 */
+	method?: 'GET' | 'PUT';
 	/**
 	 * Whether to head object to make sure the object existence before downloading.
 	 * @default false

packages/storage/src/providers/s3/utils/client/s3data/index.ts

@@ -13,7 +13,12 @@ export {
 	ListObjectsV2Input,
 	ListObjectsV2Output,
 } from './listObjectsV2';
-export { putObject, PutObjectInput, PutObjectOutput } from './putObject';
+export {
+	putObject,
+	PutObjectInput,
+	PutObjectOutput,
+	getPresignedPutObjectUrl,
+} from './putObject';
 export {
 	createMultipartUpload,
 	CreateMultipartUploadInput,

packages/storage/src/providers/s3/utils/client/s3data/putObject.ts

@@ -5,11 +5,16 @@ import {
 	Endpoint,
 	HttpRequest,
 	HttpResponse,
+	PresignUrlOptions,
+	UNSIGNED_PAYLOAD,
+	UserAgentOptions,
 	parseMetadata,
+	presignUrl,
 } from '@aws-amplify/core/internals/aws-client-utils';
 import {
 	AmplifyUrl,
 	AmplifyUrlSearchParams,
+	USER_AGENT_HEADER,
 } from '@aws-amplify/core/internals/utils';
 import { composeServiceApi } from '@aws-amplify/core/internals/aws-client-utils/composers';
 
@@ -26,6 +31,7 @@ import { validateObjectUrl } from '../../validateObjectUrl';
 
 import { defaultConfig, parseXmlError } from './base';
 import type { PutObjectCommandInput, PutObjectCommandOutput } from './types';
+import type { S3EndpointResolverOptions } from './base';
 
 export type PutObjectInput = Pick<
 	PutObjectCommandInput,
@@ -112,3 +118,50 @@ export const putObject = composeServiceApi(
 	putObjectDeserializer,
 	{ ...defaultConfig, responseType: 'text' },
 );
+
+type S3PutObjectPresignedUrlConfig = Omit<
+	UserAgentOptions & PresignUrlOptions & S3EndpointResolverOptions,
+	'signingService' | 'signingRegion'
+> & {
+	signingService?: string;
+	signingRegion?: string;
+};
+
+/**
+ * Get a presigned URL for the `putObject` API.
+ *
+ * @internal
+ */
+export const getPresignedPutObjectUrl = async (
+	config: S3PutObjectPresignedUrlConfig,
+	input: Omit<PutObjectInput, 'Body'>,
+): Promise<URL> => {
+	const endpoint = defaultConfig.endpointResolver(config, input);
+	const { url, headers, method } = await putObjectSerializer(
+		{ ...input, Body: undefined },
+		endpoint,
+	);
+
+	if (config.userAgentValue) {
+		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: UNSIGNED_PAYLOAD },
+		{
+			signingService: defaultConfig.service,
+			signingRegion: config.region,
+			...defaultConfig,
+			...config,
+		},
+	);
+};