@aws-amplify/core 5.5.2 → 5.5.3-api-v6.13

package/polyfills/URL/index.ts

@@ -1,3 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 /**
  * TODO: [v6] remove this polyfill.
  *

package/src/Amplify.ts

@@ -1,3 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 import { ConsoleLogger as LoggerClass } from './Logger';
 
 const logger = new LoggerClass('Amplify');

package/src/AwsClients/CognitoIdentity/getCredentialsForIdentity.ts

@@ -11,11 +11,11 @@ import {
 	Endpoint,
 	HttpRequest,
 	HttpResponse,
-	composeServiceApi,
 	parseJsonBody,
 	parseJsonError,
 	parseMetadata,
 } from '../../clients';
+import { composeServiceApi } from '../../clients/internal';
 import type {
 	GetCredentialsForIdentityCommandInput as GetCredentialsForIdentityInput,
 	GetCredentialsForIdentityCommandOutput as GetCredentialsForIdentityOutput,

package/src/AwsClients/CognitoIdentity/getId.ts

@@ -11,11 +11,11 @@ import {
 	Endpoint,
 	HttpRequest,
 	HttpResponse,
-	composeServiceApi,
 	parseJsonBody,
 	parseJsonError,
 	parseMetadata,
 } from '../../clients';
+import { composeServiceApi } from '../../clients/internal';
 import {
 	GetIdCommandInput as GetIdInput,
 	GetIdCommandOutput as GetIdOutput,

package/src/Credentials.ts

@@ -1,3 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 import { ConsoleLogger as Logger } from './Logger';
 import { StorageHelper } from './StorageHelper';
 import { makeQuerablePromise } from './JS';

package/src/Platform/version.ts

@@ -1,2 +1,2 @@
 // generated by genversion
-export const version = '5.3.3';
+export const version = '5.3.4-api-v6.13+5927d05d2';

package/src/Providers/index.ts

@@ -1 +1,3 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 export { AWSCloudWatchProvider } from './AWSCloudWatchProvider';

package/src/ServiceWorker/ServiceWorker.ts

@@ -1,3 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 /**
  * Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  *

package/src/ServiceWorker/index.ts

@@ -1,3 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 /**
  * Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  *

package/src/UniversalStorage/index.ts

@@ -1,3 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 import Cookies, { CookieSetOptions } from 'universal-cookie';
 import { browserOrNode } from '../JS';
 

package/src/Util/BackgroundProcessManager.ts

@@ -1,3 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 /**
  * @private For internal Amplify use.
  *

package/src/Util/DateUtils.ts

@@ -1,3 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 /**
  * Date & time utility functions to abstract the `aws-sdk` away from users.
  * (v2 => v3 modularization is a breaking change)

package/src/Util/Mutex.ts

@@ -1,3 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 /*!
  * The MIT License (MIT)
  *

package/src/Util/Reachability.native.ts

@@ -1,3 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 import Observable from 'zen-observable-ts';
 import { ConsoleLogger as Logger } from '../Logger';
 

package/src/Util/Reachability.ts

@@ -1,3 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 import { browserOrNode, isWebWorker } from '@aws-amplify/core';
 import Observable, { ZenObservable } from 'zen-observable-ts';
 

package/src/Util/Retry.ts

@@ -1,3 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 import { DelayFunction } from '../types';
 import { ConsoleLogger as Logger } from '../Logger/ConsoleLogger';
 const logger = new Logger('Util');

package/src/Util/StringUtils.ts

@@ -1,3 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 export function urlSafeEncode(str: string) {
 	return str
 		.split('')

package/src/Util/index.ts

@@ -1,3 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 export {
 	NonRetryableError,
 	isNonRetryableError,

package/src/clients/handlers/fetch.ts

@@ -4,6 +4,7 @@
 import 'isomorphic-unfetch'; // TODO: remove this dependency in v6
 import { HttpRequest, HttpResponse, HttpTransferOptions } from '../types/http';
 import { TransferHandler } from '../types/core';
+import { withMemoization } from '../utils/memoization';
 
 const shouldSendBody = (method: string) =>
 	!['HEAD', 'GET', 'DELETE'].includes(method.toUpperCase());
@@ -54,22 +55,3 @@ export const fetchTransferHandler: TransferHandler<
 		body: bodyWithMixin,
 	};
 };
-
-/**
- * Cache the payload of a response body. It allows multiple calls to the body,
- * for example, when reading the body in both retry decider and error deserializer.
- * Caching body is allowed here because we call the body accessor(blob(), json(),
- * etc.) when body is small or streaming implementation is not available(RN).
- */
-const withMemoization = <T>(payloadAccessor: () => Promise<T>) => {
-	let cached: Promise<T>;
-	return () => {
-		if (!cached) {
-			// Explicitly not awaiting. Intermediate await would add overhead and
-			// introduce a possible race in the event that this wrapper is called
-			// again before the first `payloadAccessor` call resolves.
-			cached = payloadAccessor();
-		}
-		return cached;
-	};
-};

package/src/clients/index.ts

@@ -6,10 +6,23 @@ export { getDnsSuffix } from './endpoints';
 export { fetchTransferHandler } from './handlers/fetch';
 export { unauthenticatedHandler } from './handlers/unauthenticated';
 export { authenticatedHandler } from './handlers/authenticated';
-export { composeServiceApi } from './internal/composeServiceApi';
 export {
-	signRequest,
+	getHashedPayload,
 	presignUrl,
+	PresignUrlOptions,
+	signRequest,
+	SignRequestOptions,
 } from './middleware/signing/signer/signatureV4';
+export { EMPTY_HASH as EMPTY_SHA256_HASH } from './middleware/signing/signer/signatureV4/constants';
+export { extendedEncodeURIComponent } from './middleware/signing/utils/extendedEncodeURIComponent';
+export { signingMiddleware, SigningOptions } from './middleware/signing';
+export {
+	getRetryDecider,
+	jitteredBackoff,
+	retryMiddleware,
+	RetryOptions,
+} from './middleware/retry';
+export { userAgentMiddleware, UserAgentOptions } from './middleware/userAgent';
 export { parseJsonBody, parseJsonError, parseMetadata } from './serde';
+export { withMemoization } from './utils/memoization';
 export * from './types';

package/src/clients/internal/composeServiceApi.ts

@@ -16,13 +16,16 @@ export const composeServiceApi = <
 		HttpResponse,
 		TransferHandlerOptions
 	>,
-	serializer: (input: Input, endpoint: Endpoint) => HttpRequest,
+	serializer: (
+		input: Input,
+		endpoint: Endpoint
+	) => Promise<HttpRequest> | HttpRequest,
 	deserializer: (output: HttpResponse) => Promise<Output>,
 	defaultConfig: DefaultConfig
 ) => {
 	return async (
 		config: OptionalizeKey<
-			TransferHandlerOptions & ServiceClientOptions,
+			TransferHandlerOptions & ServiceClientOptions & DefaultConfig,
 			keyof DefaultConfig
 		>,
 		input: Input
@@ -31,13 +34,16 @@ export const composeServiceApi = <
 			...defaultConfig,
 			...config,
 		} as unknown as TransferHandlerOptions & ServiceClientOptions;
-		const endpoint = await resolvedConfig.endpointResolver({
-			region: resolvedConfig.region,
-		});
+		// We may want to allow different endpoints from given config(other than region) and input.
+		// Currently S3 supports additional `useAccelerateEndpoint` option to use accelerate endpoint.
+		const endpoint = await resolvedConfig.endpointResolver(
+			resolvedConfig,
+			input
+		);
 		// Unlike AWS SDK clients, a serializer should NOT populate the `host` or `content-length` headers.
 		// Both of these headers are prohibited per Spec(https://developer.mozilla.org/en-US/docs/Glossary/Forbidden_header_name).
 		// They will be populated automatically by browser, or node-fetch polyfill.
-		const request = serializer(input, endpoint);
+		const request = await serializer(input, endpoint);
 		const response = await transferHandler(request, {
 			...resolvedConfig,
 		});

package/src/clients/internal/index.ts

@@ -0,0 +1,10 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * This index should NOT be included in the ../index.ts because the composer functions
+ * here requires TypeScript >= 4. Given other scoped packages may use TypeScript < 4,
+ * they should not be exposed to upper level index.
+ */
+export { composeServiceApi } from './composeServiceApi';
+export { composeTransferHandler } from './composeTransferHandler';

package/src/clients/middleware/retry/middleware.ts

@@ -1,7 +1,6 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { MetadataBearer } from '@aws-sdk/types';
 import {
 	MiddlewareContext,
 	MiddlewareHandler,
@@ -60,13 +59,25 @@ export const retryMiddleware = <TInput = Request, TOutput = Response>({
 			let error: Error;
 			let attemptsCount = context.attemptsCount ?? 0;
 			let response: TOutput;
+
+			// When retry is not needed or max attempts is reached, either error or response will be set. This function handles either cases.
+			const handleTerminalErrorOrResponse = () => {
+				if (response) {
+					addOrIncrementMetadataAttempts(response, attemptsCount);
+					return response;
+				} else {
+					addOrIncrementMetadataAttempts(error, attemptsCount);
+					throw error;
+				}
+			};
+
 			while (!abortSignal?.aborted && attemptsCount < maxAttempts) {
-				error = undefined;
-				response = undefined;
 				try {
 					response = await next(request);
+					error = undefined;
 				} catch (e) {
 					error = e;
+					response = undefined;
 				}
 				// context.attemptsCount may be updated after calling next handler which may retry the request by itself.
 				attemptsCount =
@@ -81,17 +92,16 @@ export const retryMiddleware = <TInput = Request, TOutput = Response>({
 						await cancellableSleep(delay, abortSignal);
 					}
 					continue;
-				} else if (response) {
-					updateMetadataAttempts(response, attemptsCount);
-					return response;
 				} else {
-					updateMetadataAttempts(error, attemptsCount);
-					throw error;
+					return handleTerminalErrorOrResponse();
 				}
 			}
-			throw abortSignal?.aborted
-				? new Error('Request aborted')
-				: error ?? new Error('Retry attempts exhausted');
+
+			if (abortSignal?.aborted) {
+				throw new Error('Request aborted.');
+			} else {
+				return handleTerminalErrorOrResponse();
+			}
 		};
 };
 
@@ -113,21 +123,15 @@ const cancellableSleep = (timeoutMs: number, abortSignal?: AbortSignal) => {
 	return sleepPromise;
 };
 
-/**
- * Check if the response is a contains `$metadata` property.
- *
- * @internal Amplify internal use only
- */
-export const isMetadataBearer = (
-	response: unknown
-): response is MetadataBearer => typeof response?.['$metadata'] === 'object';
-
-const updateMetadataAttempts = (
+const addOrIncrementMetadataAttempts = (
 	nextHandlerOutput: Object,
 	attempts: number
 ) => {
-	if (isMetadataBearer(nextHandlerOutput)) {
-		nextHandlerOutput.$metadata.attempts = attempts;
+	if (Object.prototype.toString.call(nextHandlerOutput) !== '[object Object]') {
+		return;
 	}
-	nextHandlerOutput['$metadata'] = { attempts };
+	nextHandlerOutput['$metadata'] = {
+		...(nextHandlerOutput['$metadata'] ?? {}),
+		attempts,
+	};
 };

package/src/clients/middleware/signing/middleware.ts

@@ -15,9 +15,17 @@ import { getUpdatedSystemClockOffset } from './utils/getUpdatedSystemClockOffset
  * Configuration of the signing middleware
  */
 export interface SigningOptions {
-	credentials: Credentials;
+	credentials: Credentials | (() => Promise<Credentials>);
 	region: string;
 	service: string;
+
+	/**
+	 * Whether to uri encode the path as part of canonical uri. It's used for S3 only where the pathname
+	 * is already uri encoded, and the signing process is not expected to uri encode it again.
+	 *
+	 * @default true
+	 */
+	uriEscapePath?: boolean;
 }
 
 /**
@@ -28,16 +36,19 @@ export const signingMiddleware = ({
 	credentials,
 	region,
 	service,
+	uriEscapePath = true,
 }: SigningOptions) => {
 	let currentSystemClockOffset;
 	return (next: MiddlewareHandler<HttpRequest, HttpResponse>) =>
 		async function signingMiddleware(request: HttpRequest) {
 			currentSystemClockOffset = currentSystemClockOffset ?? 0;
 			const signRequestOptions = {
-				credentials,
+				credentials:
+					typeof credentials === 'function' ? await credentials() : credentials,
 				signingDate: getSkewCorrectedDate(currentSystemClockOffset),
 				signingRegion: region,
 				signingService: service,
+				uriEscapePath,
 			};
 			const signedRequest = await signRequest(request, signRequestOptions);
 			const response = await next(signedRequest);

package/src/clients/middleware/signing/signer/signatureV4/index.native.ts

@@ -7,3 +7,4 @@ import '@aws-amplify/core/polyfills/URL';
 export { signRequest } from './signRequest';
 export { presignUrl } from './presignUrl';
 export { TOKEN_QUERY_PARAM } from './constants';
+export { getHashedPayload } from './utils/getHashedPayload';

package/src/clients/middleware/signing/signer/signatureV4/index.ts

@@ -5,3 +5,5 @@
 export { signRequest } from './signRequest';
 export { presignUrl } from './presignUrl';
 export { TOKEN_QUERY_PARAM } from './constants';
+export { getHashedPayload } from './utils/getHashedPayload';
+export type { SignRequestOptions, PresignUrlOptions } from './types';

package/src/clients/middleware/signing/signer/signatureV4/types/signer.ts

@@ -8,6 +8,16 @@ export interface SignRequestOptions {
 	signingDate?: Date;
 	signingRegion: string;
 	signingService: string;
+
+	/**
+	 * Whether to uri encode the path as part of canonical uri. It's used for S3 only where the pathname
+	 * is already uri encoded, and the signing process is not expected to uri encode it again.
+	 *
+	 * @default true
+	 *
+	 * @see https://github.com/aws/aws-sdk-js-v3/blob/9ba012dfa3a3429aa2db0f90b3b0b3a7a31f9bc3/packages/signature-v4/src/SignatureV4.ts#L76-L83
+	 */
+	uriEscapePath?: boolean;
 }
 
 export interface PresignUrlOptions extends SignRequestOptions {
@@ -26,6 +36,9 @@ export interface FormattedDates {
 export interface SigningValues
 	extends Credentials,
 		FormattedDates,
-		Pick<SignRequestOptions, 'signingRegion' | 'signingService'> {
+		Pick<
+			SignRequestOptions,
+			'signingRegion' | 'signingService' | 'uriEscapePath'
+		> {
 	credentialScope: string;
 }

package/src/clients/middleware/signing/signer/signatureV4/utils/getCanonicalRequest.ts

@@ -12,6 +12,8 @@ import { getSignedHeaders } from './getSignedHeaders';
  * Returns a canonical request.
  *
  * @param request `HttpRequest` from which to create the canonical request from.
+ * @param uriEscapePath Whether to uri encode the path as part of canonical uri. It's used for S3 only where the
+ *   pathname is already uri encoded, and the signing process is not expected to uri encode it again. Defaults to true.
  * @returns String created by by concatenating the following strings, separated by newline characters:
  * - HTTPMethod
  * - CanonicalUri
@@ -22,15 +24,13 @@ import { getSignedHeaders } from './getSignedHeaders';
  *
  * @internal
  */
-export const getCanonicalRequest = ({
-	body,
-	headers,
-	method,
-	url,
-}: HttpRequest): string =>
+export const getCanonicalRequest = (
+	{ body, headers, method, url }: HttpRequest,
+	uriEscapePath = true
+): string =>
 	[
 		method,
-		getCanonicalUri(url.pathname),
+		getCanonicalUri(url.pathname, uriEscapePath),
 		getCanonicalQueryString(url.searchParams),
 		getCanonicalHeaders(headers),
 		getSignedHeaders(headers),

package/src/clients/middleware/signing/signer/signatureV4/utils/getCanonicalUri.ts

@@ -5,10 +5,19 @@
  * Returns a canonical uri.
  *
  * @param pathname `pathname` from request url.
+ * @param uriEscapePath Whether to uri encode the path as part of canonical uri. It's used for S3 only where the
+ *   pathname is already uri encoded, and the signing process is not expected to uri encode it again. Defaults to true.
  * @returns URI-encoded version of the absolute path component URL (everything between the host and the question mark
  * character (?) that starts the query string parameters). If the absolute path is empty, a forward slash character (/).
  *
  * @internal
  */
-export const getCanonicalUri = (pathname: string): string =>
-	pathname ? encodeURIComponent(pathname).replace(/%2F/g, '/') : '/';
+export const getCanonicalUri = (
+	pathname: string,
+	uriEscapePath = true
+): string =>
+	pathname
+		? uriEscapePath
+			? encodeURIComponent(pathname).replace(/%2F/g, '/')
+			: pathname
+		: '/';

package/src/clients/middleware/signing/signer/signatureV4/utils/getSignature.ts

@@ -27,10 +27,11 @@ export const getSignature = (
 		shortDate,
 		signingRegion,
 		signingService,
+		uriEscapePath,
 	}: SigningValues
 ): string => {
 	// step 1: create a canonical request
-	const canonicalRequest = getCanonicalRequest(request);
+	const canonicalRequest = getCanonicalRequest(request, uriEscapePath);
 
 	// step 2: create a hash of the canonical request
 	const hashedRequest = getHashedDataAsHex(null, canonicalRequest);

package/src/clients/middleware/signing/signer/signatureV4/utils/getSigningValues.ts

@@ -19,6 +19,7 @@ export const getSigningValues = ({
 	signingDate = new Date(),
 	signingRegion,
 	signingService,
+	uriEscapePath = true,
 }: SignRequestOptions): SigningValues => {
 	// get properties from credentials
 	const { accessKeyId, secretAccessKey, sessionToken } = credentials;
@@ -39,5 +40,6 @@ export const getSigningValues = ({
 		shortDate,
 		signingRegion,
 		signingService,
+		uriEscapePath,
 	};
 };

package/src/clients/serde/responseInfo.ts

@@ -1,8 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { ResponseMetadata } from '@aws-sdk/types';
-import { isMetadataBearer } from '../middleware/retry/middleware';
+import { ResponseMetadata, MetadataBearer } from '@aws-sdk/types';
 import { HttpResponse } from '../types/http';
 
 export const parseMetadata = (response: HttpResponse): ResponseMetadata => {
@@ -18,3 +17,6 @@ export const parseMetadata = (response: HttpResponse): ResponseMetadata => {
 		cfId: headers['x-amz-cf-id'],
 	};
 };
+
+const isMetadataBearer = (response: unknown): response is MetadataBearer =>
+	typeof response?.['$metadata'] === 'object';

package/src/clients/types/aws.ts

@@ -1,10 +1,11 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+import { MetadataBearer } from '@aws-sdk/types';
 import { Endpoint } from './core';
 import { HttpResponse } from './http';
 
-export type { Credentials } from '@aws-sdk/types';
+export type { Credentials, MetadataBearer } from '@aws-sdk/types';
 
 export type SourceData = string | ArrayBuffer | ArrayBufferView;
 
@@ -15,7 +16,7 @@ export type EndpointResolverOptions = { region: string };
 
 export interface ServiceClientOptions {
 	region: string;
-	endpointResolver: (options: EndpointResolverOptions) => Endpoint;
+	endpointResolver: (options: EndpointResolverOptions, input?: any) => Endpoint;
 }
 
 /**
@@ -24,4 +25,4 @@ export interface ServiceClientOptions {
  */
 export type ErrorParser = (
 	response?: HttpResponse
-) => Promise<Error | undefined>;
+) => Promise<(Error & MetadataBearer) | undefined>;

package/src/clients/utils/memoization.ts

@@ -0,0 +1,23 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * Cache the payload of a response body. It allows multiple calls to the body,
+ * for example, when reading the body in both retry decider and error deserializer.
+ * Caching body is allowed here because we call the body accessor(blob(), json(),
+ * etc.) when body is small or streaming implementation is not available(RN).
+ *
+ * @internal
+ */
+export const withMemoization = <T>(payloadAccessor: () => Promise<T>) => {
+	let cached: Promise<T>;
+	return () => {
+		if (!cached) {
+			// Explicitly not awaiting. Intermediate await would add overhead and
+			// introduce a possible race in the event that this wrapper is called
+			// again before the first `payloadAccessor` call resolves.
+			cached = payloadAccessor();
+		}
+		return cached;
+	};
+};

package/src/parseAWSExports.ts

@@ -1,3 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 import { AmplifyConfig } from './types';
 import { ConsoleLogger as Logger } from './Logger';
 

package/src/types/index.ts

@@ -1 +1,3 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 export * from './types';

package/src/types/types.ts

@@ -1,3 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 import { InputLogEvent, LogGroup } from '@aws-sdk/client-cloudwatch-logs';
 import { Credentials } from '@aws-sdk/types';