@aws-amplify/core 6.0.1-preview-testing.be90020.0 → 6.0.1-ssr-api.df60e41.0

package/src/types/core.ts

@@ -16,7 +16,7 @@ export interface AmplifyConfig {
 }
 
 export type UserProfile = {
-	attributes?: Record<string, string[]>;
+	customProperties?: Record<string, string[]>;
 	demographic?: {
 		appVersion?: string;
 		locale?: string;
@@ -27,6 +27,7 @@ export type UserProfile = {
 		platformVersion?: string;
 		timezone?: string;
 	};
+	email?: string;
 	location?: {
 		city?: string;
 		country?: string;
@@ -36,6 +37,8 @@ export type UserProfile = {
 		region?: string;
 	};
 	metrics?: Record<string, number>;
+	name?: string;
+	plan?: string;
 };
 
 /**

package/src/types/errors.ts

@@ -1,14 +1,20 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-export type ErrorParams = {
+export enum AmplifyErrorCode {
+	NoEndpointId = 'NoEndpointId',
+	PlatformNotSupported = 'PlatformNotSupported',
+	Unknown = 'Unknown',
+}
+
+export type AmplifyErrorParams<ErrorCode extends string = string> = {
 	message: string;
-	name: string;
+	name: ErrorCode;
 	recoverySuggestion?: string;
 	underlyingError?: Error | unknown;
 };
 
-export type AmplifyErrorMap<ErrorCode extends string> = {
+export type AmplifyErrorMap<ErrorCode extends string = string> = {
 	[name in ErrorCode]: {
 		message: string;
 		recoverySuggestion?: string;
@@ -19,3 +25,9 @@ export type ServiceError = {
 	name: string;
 	message: string;
 };
+
+export type AssertionFunction<ErrorCode extends string = string> = (
+	assertion: boolean,
+	name: ErrorCode,
+	additionalContext?: string
+) => asserts assertion;

package/src/types/storage.ts

@@ -13,6 +13,10 @@ export type SameSite = 'strict' | 'lax' | 'none';
 export type CookieStorageData = {
 	domain?: string;
 	path?: string;
+
+	/**
+	 * Expiration in days
+	 */
 	expires?: number;
 	secure?: boolean;
 	sameSite?: SameSite;

package/src/utils/amplifyUrl/index.ts

@@ -0,0 +1,9 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import './polyfill';
+
+const AmplifyUrl = URL;
+const AmplifyUrlSearchParams = URLSearchParams;
+
+export { AmplifyUrl, AmplifyUrlSearchParams };

package/src/utils/amplifyUrl/polyfill.native.ts

@@ -0,0 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { loadUrlPolyfill } from '@aws-amplify/react-native';
+
+loadUrlPolyfill();

package/src/utils/amplifyUrl/polyfill.ts

@@ -0,0 +1,4 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+// noop - polyfills not required on platform

package/src/utils/amplifyUuid/index.ts

@@ -0,0 +1,9 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import './polyfill';
+import { v4 } from 'uuid';
+
+const amplifyUuid = v4;
+
+export { amplifyUuid };

package/src/utils/amplifyUuid/polyfill.native.ts

@@ -0,0 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { loadGetRandomValues } from '@aws-amplify/react-native';
+
+loadGetRandomValues();

package/src/utils/amplifyUuid/polyfill.ts

@@ -0,0 +1,4 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+// noop - polyfills not required on platform

package/src/utils/convert/base64/base64Decoder.ts

@@ -0,0 +1,11 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { getAtob } from '../../globalHelpers';
+import { Base64Decoder } from '../types';
+
+export const base64Decoder: Base64Decoder = {
+	convert(input) {
+		return getAtob()(input);
+	},
+};

package/src/utils/convert/base64/base64Encoder.ts

@@ -0,0 +1,18 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { getBtoa } from '../../globalHelpers';
+import { Base64Encoder } from '../types';
+import { bytesToString } from './bytesToString';
+
+export const base64Encoder: Base64Encoder = {
+	convert(input, { urlSafe } = { urlSafe: false }) {
+		const inputStr = typeof input === 'string' ? input : bytesToString(input);
+		const encodedStr = getBtoa()(inputStr);
+
+		// see details about the char replacing at https://datatracker.ietf.org/doc/html/rfc4648#section-5
+		return urlSafe
+			? encodedStr.replace(/\+/g, '-').replace(/\//g, '_')
+			: encodedStr;
+	},
+};

package/src/utils/convert/base64/bytesToString.ts

@@ -0,0 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export function bytesToString(input: Uint8Array): string {
+	return Array.from(input, byte => String.fromCodePoint(byte)).join('');
+}

package/src/utils/convert/index.ts

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

package/src/utils/convert/types.ts

@@ -0,0 +1,17 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export interface Base64EncoderConvertOptions {
+	urlSafe: boolean;
+}
+
+export interface Base64Encoder {
+	convert(
+		input: Uint8Array | string,
+		options?: Base64EncoderConvertOptions
+	): string;
+}
+
+export interface Base64Decoder {
+	convert(input: string): string;
+}

package/src/utils/deepFreeze.ts

@@ -0,0 +1,16 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export const deepFreeze = (object: any) => {
+	const propNames = Reflect.ownKeys(object);
+
+	for (const name of propNames) {
+		const value = object[name];
+
+		if ((value && typeof value === 'object') || typeof value === 'function') {
+			deepFreeze(value);
+		}
+	}
+
+	return Object.freeze(object);
+};

package/src/utils/generateRandomString.ts

@@ -0,0 +1,16 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export const generateRandomString = (length: number) => {
+	const STATE_CHARSET =
+		'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
+	let result = '';
+
+	for (let i = 0; i < length; i++) {
+		result += STATE_CHARSET.charAt(
+			Math.floor(Math.random() * STATE_CHARSET.length)
+		);
+	}
+
+	return result;
+};

package/src/{ClientDevice/android.ts → utils/getClientInfo/getClientInfo.android.ts}

@@ -2,11 +2,11 @@
 // SPDX-License-Identifier: Apache-2.0
 // @ts-ignore: missing type definition
 import { Platform, Dimensions } from 'react-native';
-import { ConsoleLogger as Logger } from '../Logger';
+import { ConsoleLogger as Logger } from '../../Logger';
 
 const logger = new Logger('DeviceInfo');
 
-export const clientInfo = () => {
+export const getClientInfo = () => {
 	const dim = Dimensions.get('screen');
 	logger.debug(Platform, dim);
 

package/src/{ClientDevice/ios.ts → utils/getClientInfo/getClientInfo.ios.ts}

@@ -2,11 +2,11 @@
 // SPDX-License-Identifier: Apache-2.0
 // @ts-ignore: missing type definition
 import { Platform, Dimensions } from 'react-native';
-import { ConsoleLogger as Logger } from '../Logger';
+import { ConsoleLogger as Logger } from '../../Logger';
 
 const logger = new Logger('DeviceInfo');
 
-export const clientInfo = () => {
+export const getClientInfo = () => {
 	const dim = Dimensions.get('screen');
 	logger.debug(Platform, dim);
 	const OS = 'ios';
@@ -21,7 +21,7 @@ export const clientInfo = () => {
 	};
 };
 
-function dimToMake(dim:{height:number, width:number;}) {
+function dimToMake(dim: { height: number; width: number }) {
 	let { height, width } = dim;
 	if (height < width) {
 		const tmp = height;

package/src/{ClientDevice/browser.ts → utils/getClientInfo/getClientInfo.ts}

@@ -1,10 +1,10 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { ConsoleLogger as Logger } from '../Logger';
+import { ConsoleLogger as Logger } from '../../Logger';
 
 const logger = new Logger('ClientDevice_Browser');
 
-export function clientInfo() {
+export function getClientInfo() {
 	if (typeof window === 'undefined') {
 		return {};
 	}
@@ -25,7 +25,7 @@ function browserClientInfo() {
 	}
 
 	const { platform, product, vendor, userAgent, language } = nav;
-	const type = browserType(userAgent);
+	const type = getBrowserType(userAgent);
 	const timezone = browserTimezone();
 
 	return {
@@ -39,24 +39,12 @@ function browserClientInfo() {
 	};
 }
 
-export function dimension() {
-	if (typeof window === 'undefined') {
-		logger.warn('No window object available to get browser client info');
-		return { width: 320, height: 320 };
-	}
-
-	return {
-		width: window.innerWidth,
-		height: window.innerHeight,
-	};
-}
-
 function browserTimezone() {
 	const tzMatch = /\(([A-Za-z\s].*)\)/.exec(new Date().toString());
 	return tzMatch ? tzMatch[1] || '' : '';
 }
 
-export function browserType(userAgent: string) {
+function getBrowserType(userAgent: string) {
 	const operaMatch = /.+(Opera[\s[A-Z]*|OPR[\sA-Z]*)\/([0-9\.]+).*/i.exec(
 		userAgent
 	);

package/src/utils/getClientInfo/index.ts

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

package/src/utils/globalHelpers/index.native.ts

@@ -0,0 +1,30 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { loadGetRandomValues, loadBase64 } from '@aws-amplify/react-native';
+import { AmplifyError } from '../../errors';
+
+loadGetRandomValues();
+const { encode, decode } = loadBase64();
+
+export const getCrypto = () => {
+	if (
+		typeof crypto !== 'undefined' &&
+		typeof crypto.getRandomValues === 'function'
+	) {
+		return crypto;
+	}
+
+	throw new AmplifyError({
+		name: 'MissingPolyfill',
+		message: 'Cannot resolve the `crypto` function from the environment.',
+	});
+};
+
+export const getBtoa = () => {
+	return encode;
+};
+
+export const getAtob = () => {
+	return decode;
+};

package/src/utils/globalHelpers/index.ts

@@ -0,0 +1,54 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { AmplifyError } from '../../errors';
+
+export const getCrypto = () => {
+	if (typeof window === 'object' && typeof window.crypto === 'object') {
+		return window.crypto;
+	}
+
+	// Next.js global polyfill
+	if (typeof crypto === 'object') {
+		return crypto;
+	}
+
+	throw new AmplifyError({
+		name: 'MissingPolyfill',
+		message: 'Cannot resolve the `crypto` function from the environment.',
+	});
+};
+
+export const getBtoa = () => {
+	// browser
+	if (typeof window !== 'undefined' && typeof window.btoa === 'function') {
+		return window.btoa;
+	}
+
+	// Next.js global polyfill
+	if (typeof btoa === 'function') {
+		return btoa;
+	}
+
+	throw new AmplifyError({
+		name: 'Base64EncoderError',
+		message: 'Cannot resolve the `btoa` function from the environment.',
+	});
+};
+
+export const getAtob = () => {
+	// browser
+	if (typeof window !== 'undefined' && typeof window.atob === 'function') {
+		return window.atob;
+	}
+
+	// Next.js global polyfill
+	if (typeof atob === 'function') {
+		return atob;
+	}
+
+	throw new AmplifyError({
+		name: 'Base64EncoderError',
+		message: 'Cannot resolve the `atob` function from the environment.',
+	});
+};

package/src/utils/index.ts

@@ -0,0 +1,17 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { generateRandomString } from './generateRandomString';
+export { getClientInfo } from './getClientInfo';
+export { isBrowser } from './isBrowser';
+export { isWebWorker } from './isWebWorker';
+export {
+	NonRetryableError,
+	isNonRetryableError,
+	jitteredBackoff,
+	jitteredExponentialRetry,
+	retry,
+} from './retry';
+export { urlSafeDecode } from './urlSafeDecode';
+export { urlSafeEncode } from './urlSafeEncode';
+export { deepFreeze } from './deepFreeze';

package/src/utils/isBrowser.ts

@@ -0,0 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export const isBrowser = () =>
+	typeof window !== 'undefined' && typeof window.document !== 'undefined';

package/src/utils/isWebWorker.ts

@@ -0,0 +1,13 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export const isWebWorker = () => {
+	if (typeof self === 'undefined') {
+		return false;
+	}
+	const selfContext = self as { WorkerGlobalScope?: any };
+	return (
+		typeof selfContext.WorkerGlobalScope !== 'undefined' &&
+		self instanceof selfContext.WorkerGlobalScope
+	);
+};

package/src/utils/retry/NonRetryableError.ts

@@ -0,0 +1,9 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export class NonRetryableError extends Error {
+	public readonly nonRetryable = true;
+	constructor(message: string) {
+		super(message);
+	}
+}

package/src/utils/retry/constants.ts

@@ -0,0 +1,4 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export const MAX_DELAY_MS = 5 * 60 * 1000;

package/src/utils/retry/index.ts

@@ -0,0 +1,8 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { NonRetryableError } from './NonRetryableError';
+export { isNonRetryableError } from './isNonRetryableError';
+export { jitteredBackoff } from './jitteredBackoff';
+export { jitteredExponentialRetry } from './jitteredExponentialRetry';
+export { retry } from './retry';

package/src/utils/retry/isNonRetryableError.ts

@@ -0,0 +1,9 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { NonRetryableError } from './NonRetryableError';
+
+export const isNonRetryableError = (obj: any): obj is NonRetryableError => {
+	const key: keyof NonRetryableError = 'nonRetryable';
+	return obj && obj[key];
+};

package/src/utils/retry/jitteredBackoff.ts

@@ -0,0 +1,21 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { DelayFunction } from '../../types';
+import { MAX_DELAY_MS } from './constants';
+
+/**
+ * @private
+ * Internal use of Amplify only
+ */
+export function jitteredBackoff(
+	maxDelayMs: number = MAX_DELAY_MS
+): DelayFunction {
+	const BASE_TIME_MS = 100;
+	const JITTER_FACTOR = 100;
+
+	return attempt => {
+		const delay = 2 ** attempt * BASE_TIME_MS + JITTER_FACTOR * Math.random();
+		return delay > maxDelayMs ? false : delay;
+	};
+}

package/src/utils/retry/jitteredExponentialRetry.ts

@@ -0,0 +1,18 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { MAX_DELAY_MS } from './constants';
+import { jitteredBackoff } from './jitteredBackoff';
+import { retry } from './retry';
+
+/**
+ * @private
+ * Internal use of Amplify only
+ */
+export const jitteredExponentialRetry = <T>(
+	functionToRetry: (...args: any[]) => T,
+	args: any[],
+	maxDelayMs: number = MAX_DELAY_MS,
+	onTerminate?: Promise<void>
+): Promise<T> =>
+	retry(functionToRetry, args, jitteredBackoff(maxDelayMs), onTerminate);

package/src/{Util/Retry.ts → utils/retry/retry.ts}

@@ -1,20 +1,11 @@
 // 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');
 
-export class NonRetryableError extends Error {
-	public readonly nonRetryable = true;
-	constructor(message: string) {
-		super(message);
-	}
-}
+import { DelayFunction } from '../../types';
+import { ConsoleLogger as Logger } from '../../Logger/ConsoleLogger';
+import { isNonRetryableError } from './isNonRetryableError';
 
-export const isNonRetryableError = (obj: any): obj is NonRetryableError => {
-	const key: keyof NonRetryableError = 'nonRetryable';
-	return obj && obj[key];
-};
+const logger = new Logger('Util');
 
 /**
  * @private
@@ -61,7 +52,6 @@ export async function retry<T>(
 			try {
 				return resolve(await functionToRetry(...args));
 			} catch (err) {
-				
 				lastError = err;
 				logger.debug(`error on ${functionToRetry.name}`, err);
 
@@ -90,33 +80,3 @@ export async function retry<T>(
 		reject(lastError);
 	});
 }
-
-const MAX_DELAY_MS = 5 * 60 * 1000;
-
-/**
- * @private
- * Internal use of Amplify only
- */
-export function jitteredBackoff(
-	maxDelayMs: number = MAX_DELAY_MS
-): DelayFunction {
-	const BASE_TIME_MS = 100;
-	const JITTER_FACTOR = 100;
-
-	return attempt => {
-		const delay = 2 ** attempt * BASE_TIME_MS + JITTER_FACTOR * Math.random();
-		return delay > maxDelayMs ? false : delay;
-	};
-}
-
-/**
- * @private
- * Internal use of Amplify only
- */
-export const jitteredExponentialRetry = <T>(
-	functionToRetry: (...args: any[]) => T,
-	args: any[],
-	maxDelayMs: number = MAX_DELAY_MS,
-	onTerminate?: Promise<void>
-): Promise<T> =>
-	retry(functionToRetry, args, jitteredBackoff(maxDelayMs), onTerminate);

package/src/utils/sessionListener/SessionListener.native.ts

@@ -0,0 +1,70 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { loadAppState } from '@aws-amplify/react-native';
+import {
+	SessionStateChangeListener,
+	SessionState,
+	SessionListenerInterface,
+} from './types';
+
+const stateChangeListeners = new Set<SessionStateChangeListener>();
+const isActive = (appState?: string) => appState === 'active';
+const isInactive = (appState?: string) =>
+	appState === 'inactive' || appState === 'background';
+
+export class SessionListener implements SessionListenerInterface {
+	private currentAppState?: string;
+
+	constructor() {
+		this.handleStateChange = this.handleStateChange.bind(this);
+
+		// Setup state listeners
+		loadAppState().addEventListener('change', this.handleStateChange);
+	}
+
+	public addStateChangeListener(
+		listener: SessionStateChangeListener,
+		notifyOnAdd: boolean = false
+	) {
+		stateChangeListeners.add(listener);
+
+		// Notify new handlers of the current state on add if the current state has been determined
+		if (notifyOnAdd && this.currentAppState !== undefined) {
+			listener(this.getSessionState());
+		}
+	}
+
+	public removeStateChangeListener(handler: SessionStateChangeListener) {
+		stateChangeListeners.delete(handler);
+	}
+
+	private handleStateChange(nextAppState: string) {
+		if (
+			(this.currentAppState === undefined ||
+				isInactive(this.currentAppState)) &&
+			isActive(nextAppState)
+		) {
+			this.notifyHandlers('started');
+		} else if (isActive(this.currentAppState) && isInactive(nextAppState)) {
+			this.notifyHandlers('ended');
+		}
+
+		this.currentAppState = nextAppState;
+	}
+
+	private notifyHandlers(state: SessionState) {
+		stateChangeListeners.forEach(listener => {
+			listener(state);
+		});
+	}
+
+	private getSessionState() {
+		if (isActive(this.currentAppState)) {
+			return 'started';
+		}
+
+		// Consider any other app state as ended
+		return 'ended';
+	}
+}