@aws-amplify/storage 6.6.5 → 6.6.6-storage-browser.4949269.0

package/src/providers/s3/utils/client/{deleteObject.ts → s3data/deleteObject.ts}

@@ -10,20 +10,20 @@ import {
 import { AmplifyUrl } from '@aws-amplify/core/internals/utils';
 import { composeServiceApi } from '@aws-amplify/core/internals/aws-client-utils/composers';
 
-import type {
-	DeleteObjectCommandInput,
-	DeleteObjectCommandOutput,
-} from './types';
-import { defaultConfig } from './base';
 import {
 	buildStorageServiceError,
 	deserializeBoolean,
 	map,
-	parseXmlError,
 	s3TransferHandler,
 	serializePathnameObjectKey,
 	validateS3RequiredParameter,
-} from './utils';
+} from '../utils';
+
+import type {
+	DeleteObjectCommandInput,
+	DeleteObjectCommandOutput,
+} from './types';
+import { defaultConfig, parseXmlError } from './base';
 
 export type DeleteObjectInput = Pick<
 	DeleteObjectCommandInput,

package/src/providers/s3/utils/client/{getObject.ts → s3data/getObject.ts}

@@ -11,15 +11,9 @@ import {
 	parseMetadata,
 	presignUrl,
 } from '@aws-amplify/core/internals/aws-client-utils';
-import { AmplifyUrl } from '@aws-amplify/core/internals/utils';
 import { composeServiceApi } from '@aws-amplify/core/internals/aws-client-utils/composers';
+import { AmplifyUrl } from '@aws-amplify/core/internals/utils';
 
-import { S3EndpointResolverOptions, defaultConfig } from './base';
-import type {
-	CompatibleHttpResponse,
-	GetObjectCommandInput,
-	GetObjectCommandOutput,
-} from './types';
 import {
 	CONTENT_SHA256_HEADER,
 	buildStorageServiceError,
@@ -28,11 +22,21 @@ import {
 	deserializeNumber,
 	deserializeTimestamp,
 	map,
-	parseXmlError,
 	s3TransferHandler,
 	serializePathnameObjectKey,
 	validateS3RequiredParameter,
-} from './utils';
+} from '../utils';
+
+import {
+	S3EndpointResolverOptions,
+	defaultConfig,
+	parseXmlError,
+} from './base';
+import type {
+	CompatibleHttpResponse,
+	GetObjectCommandInput,
+	GetObjectCommandOutput,
+} from './types';
 
 const USER_AGENT_HEADER = 'x-amz-user-agent';
 

package/src/providers/s3/utils/client/{headObject.ts → s3data/headObject.ts}

@@ -10,19 +10,19 @@ import {
 import { AmplifyUrl } from '@aws-amplify/core/internals/utils';
 import { composeServiceApi } from '@aws-amplify/core/internals/aws-client-utils/composers';
 
-import { defaultConfig } from './base';
-import type { HeadObjectCommandInput, HeadObjectCommandOutput } from './types';
 import {
 	buildStorageServiceError,
 	deserializeMetadata,
 	deserializeNumber,
 	deserializeTimestamp,
 	map,
-	parseXmlError,
 	s3TransferHandler,
 	serializePathnameObjectKey,
 	validateS3RequiredParameter,
-} from './utils';
+} from '../utils';
+
+import { defaultConfig, parseXmlError } from './base';
+import type { HeadObjectCommandInput, HeadObjectCommandOutput } from './types';
 
 export type HeadObjectInput = Pick<HeadObjectCommandInput, 'Bucket' | 'Key'>;
 

package/src/providers/s3/utils/client/{listObjectsV2.ts → s3data/listObjectsV2.ts}

@@ -13,11 +13,6 @@ import {
 } from '@aws-amplify/core/internals/utils';
 import { composeServiceApi } from '@aws-amplify/core/internals/aws-client-utils/composers';
 
-import type {
-	ListObjectsV2CommandInput,
-	ListObjectsV2CommandOutput,
-} from './types';
-import { defaultConfig } from './base';
 import {
 	assignStringVariables,
 	buildStorageServiceError,
@@ -27,9 +22,14 @@ import {
 	emptyArrayGuard,
 	map,
 	parseXmlBody,
-	parseXmlError,
 	s3TransferHandler,
-} from './utils';
+} from '../utils';
+
+import type {
+	ListObjectsV2CommandInput,
+	ListObjectsV2CommandOutput,
+} from './types';
+import { defaultConfig, parseXmlError } from './base';
 
 export type ListObjectsV2Input = ListObjectsV2CommandInput;
 

package/src/providers/s3/utils/client/{listParts.ts → s3data/listParts.ts}

@@ -13,23 +13,23 @@ import {
 } from '@aws-amplify/core/internals/utils';
 import { composeServiceApi } from '@aws-amplify/core/internals/aws-client-utils/composers';
 
-import type {
-	CompletedPart,
-	ListPartsCommandInput,
-	ListPartsCommandOutput,
-} from './types';
-import { defaultConfig } from './base';
 import {
 	buildStorageServiceError,
 	deserializeNumber,
 	emptyArrayGuard,
 	map,
 	parseXmlBody,
-	parseXmlError,
 	s3TransferHandler,
 	serializePathnameObjectKey,
 	validateS3RequiredParameter,
-} from './utils';
+} from '../utils';
+
+import type {
+	CompletedPart,
+	ListPartsCommandInput,
+	ListPartsCommandOutput,
+} from './types';
+import { defaultConfig, parseXmlError } from './base';
 
 export type ListPartsInput = Pick<
 	ListPartsCommandInput,
@@ -90,6 +90,7 @@ const deserializeCompletedPartList = (input: any[]): CompletedPart[] =>
 			PartNumber: ['PartNumber', deserializeNumber],
 			ETag: 'ETag',
 			Size: ['Size', deserializeNumber],
+			ChecksumCRC32: 'ChecksumCRC32',
 		}),
 	);
 

package/src/providers/s3/utils/client/{putObject.ts → s3data/putObject.ts}

@@ -10,18 +10,18 @@ import {
 import { AmplifyUrl } from '@aws-amplify/core/internals/utils';
 import { composeServiceApi } from '@aws-amplify/core/internals/aws-client-utils/composers';
 
-import { defaultConfig } from './base';
-import type { PutObjectCommandInput, PutObjectCommandOutput } from './types';
 import {
 	assignStringVariables,
 	buildStorageServiceError,
 	map,
-	parseXmlError,
 	s3TransferHandler,
 	serializeObjectConfigsToHeaders,
 	serializePathnameObjectKey,
 	validateS3RequiredParameter,
-} from './utils';
+} from '../utils';
+
+import { defaultConfig, parseXmlError } from './base';
+import type { PutObjectCommandInput, PutObjectCommandOutput } from './types';
 
 export type PutObjectInput = Pick<
 	PutObjectCommandInput,
@@ -37,6 +37,7 @@ export type PutObjectInput = Pick<
 	| 'Expires'
 	| 'Metadata'
 	| 'Tagging'
+	| 'ChecksumCRC32'
 >;
 
 export type PutObjectOutput = Pick<
@@ -56,6 +57,7 @@ const putObjectSerializer = async (
 			ContentType: input.ContentType ?? 'application/octet-stream',
 		})),
 		...assignStringVariables({ 'content-md5': input.ContentMD5 }),
+		...assignStringVariables({ 'x-amz-checksum-crc32': input.ChecksumCRC32 }),
 	};
 	const url = new AmplifyUrl(endpoint.url.toString());
 	validateS3RequiredParameter(!!input.Key, 'Key');

package/src/providers/s3/utils/client/{uploadPart.ts → s3data/uploadPart.ts}

@@ -13,23 +13,29 @@ import {
 } from '@aws-amplify/core/internals/utils';
 import { composeServiceApi } from '@aws-amplify/core/internals/aws-client-utils/composers';
 
-import { defaultConfig } from './base';
-import type { UploadPartCommandInput, UploadPartCommandOutput } from './types';
 import {
 	assignStringVariables,
 	buildStorageServiceError,
 	map,
-	parseXmlError,
 	s3TransferHandler,
 	serializePathnameObjectKey,
 	validateS3RequiredParameter,
-} from './utils';
+} from '../utils';
+
+import { defaultConfig, parseXmlError } from './base';
+import type { UploadPartCommandInput, UploadPartCommandOutput } from './types';
 
 // Content-length is ignored here because it's forbidden header
 // and will be set by browser or fetch polyfill.
 export type UploadPartInput = Pick<
 	UploadPartCommandInput,
-	'PartNumber' | 'Body' | 'UploadId' | 'Bucket' | 'Key' | 'ContentMD5'
+	| 'PartNumber'
+	| 'Body'
+	| 'UploadId'
+	| 'Bucket'
+	| 'Key'
+	| 'ContentMD5'
+	| 'ChecksumCRC32'
 >;
 
 export type UploadPartOutput = Pick<
@@ -42,9 +48,10 @@ const uploadPartSerializer = async (
 	endpoint: Endpoint,
 ): Promise<HttpRequest> => {
 	const headers = {
+		...assignStringVariables({ 'x-amz-checksum-crc32': input.ChecksumCRC32 }),
 		...assignStringVariables({ 'content-md5': input.ContentMD5 }),
+		'content-type': 'application/octet-stream',
 	};
-	headers['content-type'] = 'application/octet-stream';
 	const url = new AmplifyUrl(endpoint.url.toString());
 	validateS3RequiredParameter(!!input.Key, 'Key');
 	url.pathname = serializePathnameObjectKey(url, input.Key);

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

@@ -0,0 +1,96 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import {
+	ErrorParser,
+	HttpResponse,
+	MiddlewareContext,
+	RetryDeciderOutput,
+	getRetryDecider,
+} from '@aws-amplify/core/internals/aws-client-utils';
+
+import { LocationCredentialsProvider } from '../../../types/options';
+
+/**
+ * Function to decide if the S3 request should be retried. For S3 APIs, we support forceRefresh option
+ * for {@link LocationCredentialsProvider | LocationCredentialsProvider } option. It's set when S3 returns
+ * credentials expired error. In the retry decider, we detect this response and set flag to signify a retry
+ * attempt. The retry attempt would invoke the LocationCredentialsProvider with forceRefresh option set.
+ *
+ * @param response Optional response of the request.
+ * @param error Optional error thrown from previous attempts.
+ * @param middlewareContext Optional context object to store data between retries.
+ * @returns True if the request should be retried.
+ */
+export type RetryDecider = (
+	response?: HttpResponse,
+	error?: unknown,
+	middlewareContext?: MiddlewareContext,
+) => Promise<RetryDeciderOutput>;
+
+/**
+ * Factory of a {@link RetryDecider} function.
+ *
+ * @param errorParser function to parse HTTP response wth XML payload to JS
+ * 	Error instance.
+ * @returns A structure indicating if the response is retryable; And if it is a
+ * 	CredentialsExpiredError
+ */
+export const createRetryDecider =
+	(errorParser: ErrorParser): RetryDecider =>
+	async (
+		response?: HttpResponse,
+		error?: unknown,
+		middlewareContext?: MiddlewareContext,
+	): Promise<RetryDeciderOutput> => {
+		const defaultRetryDecider = getRetryDecider(errorParser);
+		const defaultRetryDecision = await defaultRetryDecider(response, error);
+		if (!response || response.statusCode < 300) {
+			return { retryable: false };
+		}
+		const parsedError = await errorParser(response);
+		const errorCode = parsedError?.name;
+		const errorMessage = parsedError?.message;
+		const isCredentialsExpired = isCredentialsExpiredError(
+			errorCode,
+			errorMessage,
+		);
+
+		return {
+			retryable:
+				defaultRetryDecision.retryable ||
+				// If we know the previous retry attempt sets isCredentialsExpired in the
+				// middleware context, we don't want to retry anymore.
+				!!(isCredentialsExpired && !middlewareContext?.isCredentialsExpired),
+			isCredentialsExpiredError: isCredentialsExpired,
+		};
+	};
+
+// Ref: https://github.com/aws/aws-sdk-js/blob/54829e341181b41573c419bd870dd0e0f8f10632/lib/event_listeners.js#L522-L541
+const INVALID_TOKEN_ERROR_CODES = [
+	'RequestExpired',
+	'ExpiredTokenException',
+	'ExpiredToken',
+];
+
+/**
+ * Given an error code, returns true if it is related to invalid credentials.
+ *
+ * @param errorCode String representation of some error.
+ * @returns True if given error indicates the credentials used to authorize request
+ * are invalid.
+ */
+const isCredentialsExpiredError = (
+	errorCode?: string,
+	errorMessage?: string,
+) => {
+	const isExpiredTokenError =
+		!!errorCode && INVALID_TOKEN_ERROR_CODES.includes(errorCode);
+	// Ref: https://github.com/aws/aws-sdk-js/blob/54829e341181b41573c419bd870dd0e0f8f10632/lib/event_listeners.js#L536-L539
+	const isExpiredSignatureError =
+		!!errorCode &&
+		!!errorMessage &&
+		errorCode.includes('Signature') &&
+		errorMessage.includes('expired');
+
+	return isExpiredTokenError || isExpiredSignatureError;
+};

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

@@ -104,6 +104,47 @@ export const deserializeTimestamp = (value: string): Date | undefined => {
 	return value ? new Date(value) : undefined;
 };
 
+/**
+ * Create a function deserializing a string to an enum value. If the string is not a valid enum value, it throws a
+ * StorageError.
+ *
+ * @example
+ * ```typescript
+ * const deserializeStringEnum = createStringEnumDeserializer(['a', 'b', 'c'] as const, 'FieldName');
+ * const deserializedArray = ['a', 'b', 'c'].map(deserializeStringEnum);
+ * // deserializedArray = ['a', 'b', 'c']
+ *
+ * const invalidValue = deserializeStringEnum('d');
+ * // Throws InvalidFieldName: Invalid FieldName: d
+ * ```
+ *
+ * @internal
+ */
+export const createStringEnumDeserializer = <T extends readonly string[]>(
+	enumValues: T,
+	fieldName: string,
+) => {
+	const deserializeStringEnum = (
+		value: any,
+	): T extends (infer E)[] ? E : never => {
+		const parsedEnumValue = value
+			? (enumValues.find(enumValue => enumValue === value) as any)
+			: undefined;
+		if (!parsedEnumValue) {
+			throw new StorageError({
+				name: `Invalid${fieldName}`,
+				message: `Invalid ${fieldName}: ${value}`,
+				recoverySuggestion:
+					'This is likely to be a bug. Please reach out to library authors.',
+			});
+		}
+
+		return parsedEnumValue;
+	};
+
+	return deserializeStringEnum;
+};
+
 /**
  * Function that makes sure the deserializer receives non-empty array.
  *

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

@@ -1,7 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-export { parseXmlBody, parseXmlError } from './parsePayload';
+export { parseXmlBody, createXmlErrorParser } from './parsePayload';
 export {
 	SEND_DOWNLOAD_PROGRESS_EVENT,
 	SEND_UPLOAD_PROGRESS_EVENT,
@@ -25,3 +25,4 @@ export {
 	serializePathnameObjectKey,
 	validateS3RequiredParameter,
 } from './serializeHelpers';
+export { createRetryDecider } from './createRetryDecider';

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

@@ -9,25 +9,43 @@ import {
 
 import { parser } from '../runtime';
 
-export const parseXmlError: ErrorParser = async (response?: HttpResponse) => {
-	if (!response || response.statusCode < 300) {
-		return;
-	}
-	const { statusCode } = response;
-	const body = await parseXmlBody(response);
-	const code = body?.Code
-		? (body.Code as string)
-		: statusCode === 404
-			? 'NotFound'
-			: statusCode.toString();
-	const message = body?.message ?? body?.Message ?? code;
-	const error = new Error(message);
+/**
+ * Factory creating a parser that parses the JS Error object from the XML
+ * response payload.
+ *
+ * @param input Input object
+ * @param input.noErrorWrapping Whether the error code and message are located
+ *   directly in the root XML element, or in a nested `<Error>` element.
+ *   See: https://smithy.io/2.0/aws/protocols/aws-restxml-protocol.html#restxml-errors
+ *
+ *   Default to false.
+ *
+ * @internal
+ */
+export const createXmlErrorParser =
+	({
+		noErrorWrapping = false,
+	}: { noErrorWrapping?: boolean } = {}): ErrorParser =>
+	async (response?: HttpResponse) => {
+		if (!response || response.statusCode < 300) {
+			return;
+		}
+		const { statusCode } = response;
+		const body = await parseXmlBody(response);
+		const errorLocation = noErrorWrapping ? body : body.Error;
+		const code = errorLocation?.Code
+			? (errorLocation.Code as string)
+			: statusCode === 404
+				? 'NotFound'
+				: statusCode.toString();
+		const message = errorLocation?.message ?? errorLocation?.Message ?? code;
+		const error = new Error(message);
 
-	return Object.assign(error, {
-		name: code,
-		$metadata: parseMetadata(response),
-	});
-};
+		return Object.assign(error, {
+			name: code,
+			$metadata: parseMetadata(response),
+		});
+	};
 
 export const parseXmlBody = async (response: HttpResponse): Promise<any> => {
 	if (!response.body) {

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

@@ -0,0 +1,11 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { CRC32Checksum } from './crc32';
+
+export const calculateContentCRC32 = async (
+	content: Blob | string | ArrayBuffer | ArrayBufferView,
+	_seed = 0,
+): Promise<CRC32Checksum | undefined> => {
+	return undefined;
+};

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

@@ -0,0 +1,51 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import crc32 from 'crc-32';
+
+export interface CRC32Checksum {
+	checksumArrayBuffer: ArrayBuffer;
+	checksum: string;
+	seed: number;
+}
+
+export const calculateContentCRC32 = async (
+	content: Blob | string | ArrayBuffer | ArrayBufferView,
+	seed = 0,
+): Promise<CRC32Checksum | undefined> => {
+	let internalSeed = seed;
+	let blob: Blob;
+
+	if (content instanceof Blob) {
+		blob = content;
+	} else {
+		blob = new Blob([content]);
+	}
+
+	await blob.stream().pipeTo(
+		new WritableStream<Uint8Array>({
+			write(chunk) {
+				internalSeed = crc32.buf(chunk, internalSeed) >>> 0;
+			},
+		}),
+	);
+	const hex = internalSeed.toString(16).padStart(8, '0');
+
+	return {
+		checksumArrayBuffer: hexToArrayBuffer(hex),
+		checksum: hexToBase64(hex),
+		seed: internalSeed,
+	};
+};
+
+const hexToArrayBuffer = (hexString: string) =>
+	new Uint8Array((hexString.match(/\w{2}/g)! ?? []).map(h => parseInt(h, 16)))
+		.buffer;
+
+const hexToBase64 = (hexString: string) =>
+	btoa(
+		hexString
+			.match(/\w{2}/g)!
+			.map((a: string) => String.fromCharCode(parseInt(a, 16)))
+			.join(''),
+	);

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

@@ -0,0 +1,11 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { StorageValidationErrorCode } from '../../../errors/types/validation';
+import { assertValidationError } from '../../../errors/utils/assertValidationError';
+
+export const resolveIdentityId = (identityId?: string): string => {
+	assertValidationError(!!identityId, StorageValidationErrorCode.NoIdentityId);
+
+	return identityId;
+};