chore(storage): update s3 serde to accomodate stricter types

Author: AllanZhengYP

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

@@ -86,7 +86,7 @@ export const list = async (
 		ContinuationToken: options?.listAll ? undefined : options?.nextToken,
 		Delimiter: getDelimiter(options),
 		ExpectedBucketOwner: options?.expectedBucketOwner,
-		EncodingType: 'url',
+		EncodingType: 'url' as const,
 	};
 	logger.debug(`listing items from "${listParams.Prefix}"`);
 

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

@@ -23,10 +23,12 @@ import {
 	validateS3RequiredParameter,
 } from '../utils';
 import { validateObjectUrl } from '../../validateObjectUrl';
+import { deserializeStringTag } from '../utils/deserializeHelpers';
 
 import type {
 	DeleteObjectCommandInput,
 	DeleteObjectCommandOutput,
+	RequestPayer,
 } from './types';
 import { defaultConfig, parseXmlError } from './base';
 
@@ -73,7 +75,10 @@ const deleteObjectDeserializer = async (
 		const content = map(response.headers, {
 			DeleteMarker: ['x-amz-delete-marker', deserializeBoolean],
 			VersionId: 'x-amz-version-id',
-			RequestCharged: 'x-amz-request-charged',
+			RequestCharged: [
+				'x-amz-request-charged',
+				deserializeStringTag<RequestPayer>,
+			],
 		});
 
 		return {

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

@@ -25,10 +25,13 @@ import {
 	s3TransferHandler,
 } from '../utils';
 import { IntegrityError } from '../../../../../errors/IntegrityError';
+import { deserializeStringTag } from '../utils/deserializeHelpers';
 
 import type {
+	ChecksumAlgorithm,
 	ListObjectsV2CommandInput,
 	ListObjectsV2CommandOutput,
+	StorageClass,
 } from './types';
 import { defaultConfig, parseXmlError } from './base';
 
@@ -83,7 +86,7 @@ const listObjectsV2Deserializer = async (
 			],
 			ContinuationToken: 'ContinuationToken',
 			Delimiter: 'Delimiter',
-			EncodingType: 'EncodingType',
+			EncodingType: ['EncodingType', deserializeStringTag<'url'>],
 			IsTruncated: ['IsTruncated', deserializeBoolean],
 			KeyCount: ['KeyCount', deserializeNumber],
 			MaxKeys: ['MaxKeys', deserializeNumber],
@@ -124,12 +127,12 @@ const deserializeObject = (output: any) =>
 			value => emptyArrayGuard(value, deserializeChecksumAlgorithmList),
 		],
 		Size: ['Size', deserializeNumber],
-		StorageClass: 'StorageClass',
+		StorageClass: ['StorageClass', deserializeStringTag<StorageClass>],
 		Owner: ['Owner', deserializeOwner],
 	});
 
 const deserializeChecksumAlgorithmList = (output: any[]) =>
-	output.map(entry => String(entry));
+	output.map(deserializeStringTag<ChecksumAlgorithm>);
 
 const deserializeOwner = (output: any) =>
 	map(output, { DisplayName: 'DisplayName', ID: 'ID' });

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

@@ -4255,7 +4255,7 @@ export interface PutObjectCommandInput extends Omit<PutObjectRequest, 'Body'> {
 	/**
 	 * For *`PutObjectRequest["Body"]`*, see {@link PutObjectRequest.Body}.
 	 */
-		Body?: string | Blob | ArrayBuffer | ArrayBufferView;
+	Body?: string | Blob | ArrayBuffer | ArrayBufferView;
 }
 /**
  * @public

packages/storage/src/providers/s3/utils/client/utils/deserializeHelpers.ts

@@ -112,6 +112,9 @@ export const deserializeTimestamp = (value: string): Date | undefined => {
  * Create a function deserializing a string to an enum value. If the string is not a valid enum value, it throws a
  * StorageError.
  *
+ * This utility is ONLY preferred if the enum value is critical. Since the enum values are hard-coded, new enum values
+ * returned from service would break the library.
+ *
  * @example
  * ```typescript
  * const deserializeStringEnum = createStringEnumDeserializer(['a', 'b', 'c'] as const, 'FieldName');
@@ -130,7 +133,7 @@ export const createStringEnumDeserializer = <T extends readonly string[]>(
 ) => {
 	const deserializeStringEnum = (
 		value: any,
-	): T extends (infer E)[] ? E : never => {
+	): T extends readonly (infer E)[] ? E : never => {
 		const parsedEnumValue = value
 			? (enumValues.find(enumValue => enumValue === value) as any)
 			: undefined;
@@ -149,6 +152,18 @@ export const createStringEnumDeserializer = <T extends readonly string[]>(
 	return deserializeStringEnum;
 };
 
+/**
+ * Deserializes a string if a string tag type. The function simply cast the parsed string into a given string tag type.
+ * It does NOT validate whether the string value against the string tag. This behavior is the same to AWS SDK parsing
+ * logic of string tag types.
+ *
+ * If you need to verify the string value, you must use {@link createStringEnumDeserializer} instead.
+ *
+ * @internal
+ */
+export const deserializeStringTag = <T extends string>(value: any): T =>
+	String(value) as T;
+
 /**
  * Function that makes sure the deserializer receives non-empty array.
  *
@@ -173,7 +188,7 @@ export const emptyArrayGuard = <T extends any[]>(
  */
 export const deserializeMetadata = (
 	headers: Headers,
-): Record<string, string> => {
+): Record<string, string> | undefined => {
 	const objectMetadataHeaderPrefix = 'x-amz-meta-';
 	const deserialized = Object.keys(headers)
 		.filter(header => header.startsWith(objectMetadataHeaderPrefix))