@aws-amplify/core 5.8.6-api-v6-models.b3abc9b.0 → 6.0.0

package/src/Reachability/Reachability.ts

@@ -0,0 +1,55 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { CompletionObserver, Observable, from } from 'rxjs';
+import { isWebWorker } from '../libraryUtils';
+import { NetworkStatus } from './types';
+
+export class Reachability {
+	private static _observers: Array<CompletionObserver<NetworkStatus>> = [];
+
+	networkMonitor(_?: unknown): Observable<NetworkStatus> {
+		const globalObj = isWebWorker()
+			? self
+			: typeof window !== 'undefined' && window;
+
+		if (!globalObj) {
+			return from([{ online: true }]);
+		}
+
+		return new Observable(observer => {
+			observer.next({ online: globalObj.navigator.onLine });
+
+			const notifyOnline = () => observer.next({ online: true });
+			const notifyOffline = () => observer.next({ online: false });
+
+			globalObj.addEventListener('online', notifyOnline);
+			globalObj.addEventListener('offline', notifyOffline);
+
+			Reachability._observers.push(observer);
+
+			return () => {
+				globalObj.removeEventListener('online', notifyOnline);
+				globalObj.removeEventListener('offline', notifyOffline);
+
+				Reachability._observers = Reachability._observers.filter(
+					_observer => _observer !== observer
+				);
+			};
+		});
+	}
+
+	// expose observers to simulate offline mode for integration testing
+	private static _observerOverride(status: NetworkStatus): void {
+		for (const observer of this._observers) {
+			if (observer.closed) {
+				this._observers = this._observers.filter(
+					_observer => _observer !== observer
+				);
+				continue;
+			}
+
+			observer?.next && observer.next(status);
+		}
+	}
+}

package/src/Reachability/index.ts

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

package/src/Reachability/types.ts

@@ -0,0 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export type NetworkStatus = {
+	online: boolean;
+};

package/src/ServiceWorker/ServiceWorker.ts

@@ -1,20 +1,13 @@
 // 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.
- *
- * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
- * the License. A copy of the License is located at
- *
- *     http://aws.amazon.com/apache2.0/
- *
- * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
- * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
- * and limitations under the License.
- */
+
 import { ConsoleLogger as Logger } from '../Logger';
-import { browserOrNode } from '../JS';
-import { Amplify } from '../Amplify';
+import { isBrowser } from '../utils';
+import { AmplifyError } from '../errors';
+import { assert, ServiceWorkerErrorCode } from './errorHelpers';
+import { record } from '../providers/pinpoint';
+import { Amplify, fetchAuthSession } from '../singleton';
+
 /**
  * Provides a means to registering a service worker in the browser
  * and communicating with it via postMessage events.
@@ -29,17 +22,17 @@ import { Amplify } from '../Amplify';
  */
 export class ServiceWorkerClass {
 	// The active service worker will be set once it is registered
-	private _serviceWorker: ServiceWorker;
+	private _serviceWorker?: ServiceWorker;
 
 	// The service worker registration object
-	private _registration: ServiceWorkerRegistration;
+	private _registration?: ServiceWorkerRegistration;
 
 	// The application server public key for Push
 	// https://web-push-codelab.glitch.me/
-	private _publicKey: string;
+	private _publicKey?: string;
 
 	// push subscription
-	private _subscription: PushSubscription;
+	private _subscription?: PushSubscription;
 
 	// The AWS Amplify logger
 	private _logger: Logger = new Logger('ServiceWorker');
@@ -50,6 +43,11 @@ export class ServiceWorkerClass {
 	 * Get the currently active service worker
 	 */
 	get serviceWorker(): ServiceWorker {
+		assert(
+			this._serviceWorker !== undefined,
+			ServiceWorkerErrorCode.UndefinedInstance
+		);
+
 		return this._serviceWorker;
 	}
 
@@ -91,10 +89,21 @@ export class ServiceWorkerClass {
 					})
 					.catch(error => {
 						this._logger.debug(`Service Worker Registration Failed ${error}`);
-						return reject(error);
+						return reject(
+							new AmplifyError({
+								name: ServiceWorkerErrorCode.Unavailable,
+								message: 'Service Worker not available',
+								underlyingError: error,
+							})
+						);
 					});
 			} else {
-				return reject(new Error('Service Worker not available'));
+				return reject(
+					new AmplifyError({
+						name: ServiceWorkerErrorCode.Unavailable,
+						message: 'Service Worker not available',
+					})
+				);
 			}
 		});
 	}
@@ -111,10 +120,17 @@ export class ServiceWorkerClass {
 	 *  - reject(Error)
 	 */
 	enablePush(publicKey: string) {
-		if (!this._registration) throw new Error('Service Worker not registered');
+		assert(
+			this._registration !== undefined,
+			ServiceWorkerErrorCode.UndefinedRegistration
+		);
 		this._publicKey = publicKey;
 		return new Promise((resolve, reject) => {
-			if (browserOrNode().isBrowser) {
+			if (isBrowser()) {
+				assert(
+					this._registration !== undefined,
+					ServiceWorkerErrorCode.UndefinedRegistration
+				);
 				this._registration.pushManager.getSubscription().then(subscription => {
 					if (subscription) {
 						this._subscription = subscription;
@@ -124,11 +140,10 @@ export class ServiceWorkerClass {
 						resolve(subscription);
 					} else {
 						this._logger.debug(`User is NOT subscribed to push`);
-						return this._registration.pushManager
-							.subscribe({
-								userVisibleOnly: true,
-								applicationServerKey: this._urlB64ToUint8Array(publicKey),
-							})
+						return this._registration!.pushManager.subscribe({
+							userVisibleOnly: true,
+							applicationServerKey: this._urlB64ToUint8Array(publicKey),
+						})
 							.then(subscription => {
 								this._subscription = subscription;
 								this._logger.debug(
@@ -142,7 +157,12 @@ export class ServiceWorkerClass {
 					}
 				});
 			} else {
-				return reject(new Error('Service Worker not available'));
+				return reject(
+					new AmplifyError({
+						name: ServiceWorkerErrorCode.Unavailable,
+						message: 'Service Worker not available',
+					})
+				);
 			}
 		});
 	}
@@ -187,19 +207,30 @@ export class ServiceWorkerClass {
 	 * https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorker/state
 	 **/
 	_setupListeners() {
-		this._serviceWorker.addEventListener('statechange', event => {
-			const currentState = this._serviceWorker.state;
+		this.serviceWorker.addEventListener('statechange', async event => {
+			const currentState = this.serviceWorker.state;
 			this._logger.debug(`ServiceWorker statechange: ${currentState}`);
-			if (Amplify.Analytics && typeof Amplify.Analytics.record === 'function') {
-				Amplify.Analytics.record({
-					name: 'ServiceWorker',
-					attributes: {
-						state: currentState,
+
+			const { appId, region } = Amplify.getConfig().Analytics?.Pinpoint ?? {};
+			const { credentials } = await fetchAuthSession();
+
+			if (appId && region && credentials) {
+				// Pinpoint is configured, record an event
+				record({
+					appId,
+					region,
+					category: 'Core',
+					credentials,
+					event: {
+						name: 'ServiceWorker',
+						attributes: {
+							state: currentState,
+						},
 					},
 				});
 			}
 		});
-		this._serviceWorker.addEventListener('message', event => {
+		this.serviceWorker.addEventListener('message', event => {
 			this._logger.debug(`ServiceWorker message event: ${event}`);
 		});
 	}

package/src/ServiceWorker/errorHelpers.ts

@@ -0,0 +1,26 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { createAssertionFunction } from '../errors';
+import { AmplifyErrorMap, AssertionFunction } from '../types';
+
+export enum ServiceWorkerErrorCode {
+	UndefinedInstance = 'UndefinedInstance',
+	UndefinedRegistration = 'UndefinedRegistration',
+	Unavailable = 'Unavailable',
+}
+
+const serviceWorkerErrorMap: AmplifyErrorMap<ServiceWorkerErrorCode> = {
+	[ServiceWorkerErrorCode.UndefinedInstance]: {
+		message: 'Service Worker instance is undefined.',
+	},
+	[ServiceWorkerErrorCode.UndefinedRegistration]: {
+		message: 'Service Worker registration is undefined.',
+	},
+	[ServiceWorkerErrorCode.Unavailable]: {
+		message: 'Service Worker not available.',
+	},
+};
+
+export const assert: AssertionFunction<ServiceWorkerErrorCode> =
+	createAssertionFunction(serviceWorkerErrorMap);

package/src/ServiceWorker/index.ts

@@ -1,16 +1,4 @@
 // 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.
- *
- * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
- * the License. A copy of the License is located at
- *
- *     http://aws.amazon.com/apache2.0/
- *
- * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
- * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
- * and limitations under the License.
- */
 
 export { ServiceWorkerClass as ServiceWorker } from './ServiceWorker';

package/src/Signer/DateUtils.ts

@@ -0,0 +1,103 @@
+// 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)
+ *
+ * @see https://github.com/aws/aws-sdk-js/blob/6edf586dcc1de7fe8fbfbbd9a0d2b1847921e6e1/lib/util.js#L262
+ */
+
+const FIVE_MINUTES_IN_MS = 1000 * 60 * 5;
+type DateUtils = {
+	clockOffset: number;
+	getDateWithClockOffset: () => Date;
+	getClockOffset: () => number;
+	getHeaderStringFromDate: (date: Date) => string;
+	getDateFromHeaderString: (header: string) => Date;
+	isClockSkewed: (serverDate: Date) => boolean;
+	isClockSkewError: (error: any) => boolean;
+	setClockOffset: (offset: number) => void;
+};
+
+/**
+ * This utility is intended to be deprecated and replaced by `signRequest` and `presignUrl` functions from
+ * `clients/middleware/signing/signer/signatureV4`.
+ *
+ * TODO: refactor the logics here into `signRequest` and `presignUrl` functions and remove this class.
+ *
+ * @internal
+ * @deprecated
+ */
+export const DateUtils: DateUtils = {
+	/**
+	 * Milliseconds to offset the date to compensate for clock skew between device & services
+	 */
+	clockOffset: 0,
+
+	getDateWithClockOffset() {
+		if (DateUtils.clockOffset) {
+			return new Date(new Date().getTime() + DateUtils.clockOffset);
+		} else {
+			return new Date();
+		}
+	},
+
+	/**
+	 * @returns {number} Clock offset in milliseconds
+	 */
+	getClockOffset() {
+		return DateUtils.clockOffset;
+	},
+
+	getHeaderStringFromDate(date: Date = DateUtils.getDateWithClockOffset()) {
+		return date.toISOString().replace(/[:\-]|\.\d{3}/g, '');
+	},
+
+	getDateFromHeaderString(header: string) {
+		const [, year, month, day, hour, minute, second] = header.match(
+			/^(\d{4})(\d{2})(\d{2})T(\d{2})(\d{2})(\d{2}).+/
+		) as any[];
+
+		return new Date(
+			Date.UTC(
+				Number(year),
+				Number(month) - 1,
+				Number(day),
+				Number(hour),
+				Number(minute),
+				Number(second)
+			)
+		);
+	},
+
+	isClockSkewed(serverDate: Date) {
+		// API gateway permits client calls that are off by no more than ±5 minutes
+		return (
+			Math.abs(
+				serverDate.getTime() - DateUtils.getDateWithClockOffset().getTime()
+			) >= FIVE_MINUTES_IN_MS
+		);
+	},
+
+	isClockSkewError(error: { response: { headers: any } }) {
+		if (!error.response || !error.response.headers) {
+			return false;
+		}
+
+		const { headers } = error.response;
+
+		return Boolean(
+			['BadRequestException', 'InvalidSignatureException'].includes(
+				headers['x-amzn-errortype']
+			) &&
+				(headers.date || headers.Date)
+		);
+	},
+
+	/**
+	 * @param {number} offset Clock offset in milliseconds
+	 */
+	setClockOffset(offset: number) {
+		DateUtils.clockOffset = offset;
+	},
+};

package/src/Signer/Signer.ts

@@ -0,0 +1,203 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { DateUtils } from './DateUtils';
+import {
+	presignUrl,
+	signRequest,
+	TOKEN_QUERY_PARAM,
+} from '../clients/middleware/signing/signer/signatureV4';
+import { AmplifyUrl } from '../utils/amplifyUrl';
+
+const IOT_SERVICE_NAME = 'iotdevicegateway';
+// Best practice regex to parse the service and region from an AWS endpoint
+const AWS_ENDPOINT_REGEX = /([^\.]+)\.(?:([^\.]*)\.)?amazonaws\.com(.cn)?$/;
+
+/**
+ * This class is intended to be deprecated and replaced by `signRequest` and `presignUrl` functions from
+ * `clients/middleware/signing/signer/signatureV4`.
+ *
+ * TODO: refactor the logics here into `signRequest` and `presignUrl` functions and remove this class.
+ *
+ * @internal
+ * @deprecated
+ */
+export class Signer {
+	/**
+    * Sign a HTTP request, add 'Authorization' header to request param
+    * @method sign
+    * @memberof Signer
+    * @static
+    *
+    * @param {object} request - HTTP request object
+    <pre>
+    request: {
+        method: GET | POST | PUT ...
+        url: ...,
+        headers: {
+            header1: ...
+        },
+        data: data
+    }
+    </pre>
+    * @param {object} access_info - AWS access credential info
+    <pre>
+    access_info: {
+        access_key: ...,
+        secret_key: ...,
+        session_token: ...
+    }
+    </pre>
+    * @param {object} [service_info] - AWS service type and region, optional,
+    *                                  if not provided then parse out from url
+    <pre>
+    service_info: {
+        service: ...,
+        region: ...
+    }
+    </pre>
+    *
+    * @returns {object} Signed HTTP request
+    */
+	static sign(
+		request: {
+			headers: any;
+			body?: BodyInit;
+			data?: any;
+			url: string;
+			method: string;
+		},
+		accessInfo: {
+			access_key: string;
+			secret_key: string;
+			session_token: string;
+		},
+		serviceInfo: { service: string; region: string }
+	) {
+		request.headers = request.headers || {};
+
+		if (request.body && !request.data) {
+			throw new Error(
+				'The attribute "body" was found on the request object. Please use the attribute "data" instead.'
+			);
+		}
+
+		const requestToSign = {
+			...request,
+			body: request.data,
+			url: new AmplifyUrl(request.url),
+		};
+
+		const options = getOptions(requestToSign, accessInfo, serviceInfo);
+		const signedRequest: any = signRequest(requestToSign, options);
+		// Prior to using `signRequest`, Signer accepted urls as strings and outputted urls as string. Coerce the property
+		// back to a string so as not to disrupt consumers of Signer.
+		signedRequest.url = signedRequest.url.toString();
+		// HTTP headers should be case insensitive but, to maintain parity with the previous Signer implementation and
+		// limit the impact of this implementation swap, replace lowercased headers with title cased ones.
+		signedRequest.headers.Authorization = signedRequest.headers.authorization;
+		signedRequest.headers['X-Amz-Security-Token'] =
+			signedRequest.headers['x-amz-security-token'];
+		delete signedRequest.headers.authorization;
+		delete signedRequest.headers['x-amz-security-token'];
+		return signedRequest;
+	}
+
+	static signUrl(
+		urlToSign: string,
+		accessInfo: any,
+		serviceInfo?: any,
+		expiration?: number
+	): string;
+	static signUrl(
+		request: any,
+		accessInfo: any,
+		serviceInfo?: any,
+		expiration?: number
+	): string;
+	static signUrl(
+		urlOrRequest: string | any,
+		accessInfo: any,
+		serviceInfo?: any,
+		expiration?: number
+	): string {
+		const urlToSign: string =
+			typeof urlOrRequest === 'object' ? urlOrRequest.url : urlOrRequest;
+		const method: string =
+			typeof urlOrRequest === 'object' ? urlOrRequest.method : 'GET';
+		const body: any =
+			typeof urlOrRequest === 'object' ? urlOrRequest.body : undefined;
+
+		const presignable = {
+			body,
+			method,
+			url: new AmplifyUrl(urlToSign),
+		};
+
+		const options = getOptions(
+			presignable,
+			accessInfo,
+			serviceInfo,
+			expiration
+		);
+		const signedUrl = presignUrl(presignable, options);
+		if (
+			accessInfo.session_token &&
+			!sessionTokenRequiredInSigning(options.signingService)
+		) {
+			signedUrl.searchParams.append(
+				TOKEN_QUERY_PARAM,
+				accessInfo.session_token
+			);
+		}
+		return signedUrl.toString();
+	}
+}
+
+const getOptions = (
+	request: { url: URL } & Record<string, any>,
+	accessInfo: { access_key: string; secret_key: string; session_token: string },
+	serviceInfo: { service: string; region: string },
+	expiration?: number
+) => {
+	const { access_key, secret_key, session_token } = accessInfo ?? {};
+	const { region: urlRegion, service: urlService } = parseServiceInfo(
+		request.url
+	);
+	const { region = urlRegion, service = urlService } = serviceInfo ?? {};
+	const credentials = {
+		accessKeyId: access_key,
+		secretAccessKey: secret_key,
+		...(sessionTokenRequiredInSigning(service)
+			? { sessionToken: session_token }
+			: {}),
+	};
+	return {
+		credentials,
+		signingDate: DateUtils.getDateWithClockOffset(),
+		signingRegion: region,
+		signingService: service,
+		...(expiration && { expiration }),
+	};
+};
+
+const parseServiceInfo = (url: URL) => {
+	const host = url.host;
+	const matched = host.match(AWS_ENDPOINT_REGEX) ?? [];
+	let parsed = matched.slice(1, 3);
+
+	if (parsed[1] === 'es') {
+		// Elastic Search
+		parsed = parsed.reverse();
+	}
+
+	return {
+		service: parsed[0],
+		region: parsed[1],
+	};
+};
+
+// IoT service does not allow the session token in the canonical request
+// https://docs.aws.amazon.com/general/latest/gr/sigv4-add-signature-to-request.html
+const sessionTokenRequiredInSigning = (service: string) =>
+	service !== IOT_SERVICE_NAME;

package/src/Signer/index.ts

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

package/src/adapterCore/error/AmplifyServerContextError.ts

@@ -0,0 +1,23 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { AmplifyError } from '../../errors';
+
+export class AmplifyServerContextError extends AmplifyError {
+	constructor({
+		message,
+		recoverySuggestion,
+		underlyingError,
+	}: {
+		message: string;
+		recoverySuggestion?: string;
+		underlyingError?: Error;
+	}) {
+		super({
+			name: 'AmplifyServerContextError',
+			message,
+			recoverySuggestion,
+			underlyingError,
+		});
+	}
+}

package/src/adapterCore/error/index.ts

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

package/src/adapterCore/index.ts

@@ -0,0 +1,11 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export {
+	createAmplifyServerContext,
+	getAmplifyServerContext,
+	destroyAmplifyServerContext,
+	AmplifyServer,
+	CookieStorage,
+} from './serverContext';
+export { AmplifyServerContextError } from './error';

package/src/adapterCore/serverContext/index.ts

@@ -0,0 +1,10 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export {
+	createAmplifyServerContext,
+	destroyAmplifyServerContext,
+	getAmplifyServerContext,
+} from './serverContext';
+
+export { AmplifyServer, CookieStorage } from './types';