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

package/src/I18n/index.ts

@@ -4,12 +4,13 @@
 import { I18n as I18nClass } from './I18n';
 
 import { ConsoleLogger as Logger } from '../Logger';
-import { Amplify } from '../Amplify';
+import { I18nConfig } from './types';
+import { assert, I18nErrorCode } from './errorHelpers';
 
 const logger = new Logger('I18n');
 
-let _config = null;
-let _i18n = null;
+let _config: I18nConfig = { language: null };
+let _i18n: I18nClass | null = null;
 
 /**
  * Export I18n APIs
@@ -21,7 +22,7 @@ export class I18n {
 	 * Configure I18n part
 	 * @param {Object} config - Configuration of the I18n
 	 */
-	static configure(config) {
+	static configure(config: Record<string, any>) {
 		logger.debug('configure I18n');
 		if (!config) {
 			return _config;
@@ -48,7 +49,7 @@ export class I18n {
 		if (_i18n) {
 			return;
 		}
-		_i18n = new I18nClass(_config);
+		_i18n = new I18nClass();
 	}
 
 	/**
@@ -56,8 +57,9 @@ export class I18n {
 	 * Explicitly setting language
 	 * @param {String} lang
 	 */
-	static setLanguage(lang) {
+	static setLanguage(lang: string) {
 		I18n.checkConfig();
+		assert(!!_i18n, I18nErrorCode.NotConfigured);
 
 		return _i18n.setLanguage(lang);
 	}
@@ -68,10 +70,11 @@ export class I18n {
 	 * @param {String} key
 	 * @param {String} defVal - Default value
 	 */
-	static get(key, defVal?) {
+	static get(key: string, defVal?: string) {
 		if (!I18n.checkConfig()) {
 			return typeof defVal === 'undefined' ? key : defVal;
 		}
+		assert(!!_i18n, I18nErrorCode.NotConfigured);
 
 		return _i18n.get(key, defVal);
 	}
@@ -83,8 +86,12 @@ export class I18n {
 	 * @param {String} langurage - Language of the dictionary
 	 * @param {Object} vocabularies - Object that has key-value as dictionary entry
 	 */
-	static putVocabulariesForLanguage(language, vocabularies) {
+	static putVocabulariesForLanguage(
+		language: string,
+		vocabularies: Record<string, string>
+	) {
 		I18n.checkConfig();
+		assert(!!_i18n, I18nErrorCode.NotConfigured);
 
 		return _i18n.putVocabulariesForLanguage(language, vocabularies);
 	}
@@ -96,19 +103,21 @@ export class I18n {
 	 * @param {Object} vocabularies - Object that has language as key,
 	 *                                vocabularies of each language as value
 	 */
-	static putVocabularies(vocabularies) {
+	static putVocabularies(vocabularies: Record<string, Record<string, string>>) {
 		I18n.checkConfig();
+		assert(!!_i18n, I18nErrorCode.NotConfigured);
 
 		return _i18n.putVocabularies(vocabularies);
 	}
 
 	public static checkConfig() {
 		if (!_i18n) {
-			_i18n = new I18nClass(_config);
+			I18n.createInstance();
 		}
 
 		return true;
 	}
 }
 
-Amplify.register(I18n);
+// Create an instance of I18n in the static class
+I18n.createInstance();

package/src/I18n/types.ts

@@ -1,6 +1,6 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-export class I18nOptions {
+export class I18nConfig {
 	language = null;
 }

package/src/Logger/ConsoleLogger.ts

@@ -1,12 +1,11 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { InputLogEvent } from '@aws-sdk/client-cloudwatch-logs';
-import { LoggingProvider } from '../types';
-import { AWS_CLOUDWATCH_CATEGORY } from '../Util/Constants';
+import { LoggingProvider, InputLogEvent } from '../types';
+import { AWS_CLOUDWATCH_CATEGORY } from '../constants';
 import { Logger } from './logger-interface';
 
-const LOG_LEVELS = {
+const LOG_LEVELS: Record<string, number> = {
 	VERBOSE: 1,
 	DEBUG: 2,
 	INFO: 3,
@@ -30,7 +29,7 @@ export class ConsoleLogger implements Logger {
 	name: string;
 	level: LOG_TYPE | string;
 	private _pluggables: LoggingProvider[];
-	private _config: object;
+	private _config?: object;
 
 	/**
 	 * @constructor
@@ -44,7 +43,7 @@ export class ConsoleLogger implements Logger {
 
 	static LOG_LEVEL = null;
 
-	_padding(n) {
+	_padding(n: number) {
 		return n < 10 ? '0' + n : '' + n;
 	}
 
@@ -74,7 +73,7 @@ export class ConsoleLogger implements Logger {
 	 * @param {LOG_TYPE|string} type - log type, default INFO
 	 * @param {string|object} msg - Logging message or object
 	 */
-	_log(type: LOG_TYPE | string, ...msg) {
+	_log(type: LOG_TYPE | string, ...msg: any) {
 		let logger_level_name = this.level;
 		if (ConsoleLogger.LOG_LEVEL) {
 			logger_level_name = ConsoleLogger.LOG_LEVEL;
@@ -130,7 +129,7 @@ export class ConsoleLogger implements Logger {
 	 * @memeberof Logger
 	 * @param {string|object} msg - Logging message or object
 	 */
-	log(...msg) {
+	log(...msg: any) {
 		this._log(LOG_TYPE.INFO, ...msg);
 	}
 
@@ -140,7 +139,7 @@ export class ConsoleLogger implements Logger {
 	 * @memeberof Logger
 	 * @param {string|object} msg - Logging message or object
 	 */
-	info(...msg) {
+	info(...msg: any) {
 		this._log(LOG_TYPE.INFO, ...msg);
 	}
 
@@ -150,7 +149,7 @@ export class ConsoleLogger implements Logger {
 	 * @memeberof Logger
 	 * @param {string|object} msg - Logging message or object
 	 */
-	warn(...msg) {
+	warn(...msg: any) {
 		this._log(LOG_TYPE.WARN, ...msg);
 	}
 
@@ -160,7 +159,7 @@ export class ConsoleLogger implements Logger {
 	 * @memeberof Logger
 	 * @param {string|object} msg - Logging message or object
 	 */
-	error(...msg) {
+	error(...msg: any) {
 		this._log(LOG_TYPE.ERROR, ...msg);
 	}
 
@@ -170,7 +169,7 @@ export class ConsoleLogger implements Logger {
 	 * @memeberof Logger
 	 * @param {string|object} msg - Logging message or object
 	 */
-	debug(...msg) {
+	debug(...msg: any) {
 		this._log(LOG_TYPE.DEBUG, ...msg);
 	}
 
@@ -180,7 +179,7 @@ export class ConsoleLogger implements Logger {
 	 * @memeberof Logger
 	 * @param {string|object} msg - Logging message or object
 	 */
-	verbose(...msg) {
+	verbose(...msg: any) {
 		this._log(LOG_TYPE.VERBOSE, ...msg);
 	}
 

package/src/Mutex/Mutex.ts

@@ -0,0 +1,78 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+/*!
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2016 Christian Speckner <cnspeckn@googlemail.com>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+import { MutexInterface } from './types';
+
+export class Mutex implements MutexInterface {
+	isLocked(): boolean {
+		return this._pending;
+	}
+
+	acquire(): Promise<MutexInterface.Releaser> {
+		const ticket = new Promise<MutexInterface.Releaser>(resolve =>
+			this._queue.push(resolve)
+		);
+
+		if (!this._pending) {
+			this._dispatchNext();
+		}
+
+		return ticket;
+	}
+
+	runExclusive<T>(callback: MutexInterface.Worker<T>): Promise<T> {
+		return this.acquire().then(release => {
+			let result: T | Promise<T>;
+
+			try {
+				result = callback();
+			} catch (e) {
+				release();
+				throw e;
+			}
+
+			return Promise.resolve(result).then(
+				(x: T) => (release(), x),
+				e => {
+					release();
+					throw e;
+				}
+			);
+		});
+	}
+
+	private _dispatchNext(): void {
+		if (this._queue.length > 0) {
+			this._pending = true;
+			this._queue.shift()!(this._dispatchNext.bind(this));
+		} else {
+			this._pending = false;
+		}
+	}
+
+	private _queue: Array<(release: MutexInterface.Releaser) => void> = [];
+	private _pending = false;
+}

package/src/Mutex/index.ts

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

package/src/Mutex/types.ts

@@ -0,0 +1,20 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export interface MutexInterface {
+	acquire(): Promise<MutexInterface.Releaser>;
+
+	runExclusive<T>(callback: MutexInterface.Worker<T>): Promise<T>;
+
+	isLocked(): boolean;
+}
+
+export namespace MutexInterface {
+	export interface Releaser {
+		(): void;
+	}
+
+	export interface Worker<T> {
+		(): Promise<T> | T;
+	}
+}

package/src/Platform/customUserAgent.ts

@@ -0,0 +1,75 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	AdditionalDetails,
+	CategoryUserAgentStateMap,
+	CustomUserAgentStateMap,
+	SetCustomUserAgentInput,
+} from './types';
+
+// Maintains custom user-agent state set by external consumers.
+const customUserAgentState: CustomUserAgentStateMap = {};
+
+/**
+ * Sets custom user agent state which will be appended to applicable requests. Returns a function that can be used to
+ * clean up any custom state set with this API.
+ *
+ * @note
+ * This API operates globally. Calling this API multiple times will result in the most recently set values for a
+ * particular API being used.
+ *
+ * @note
+ * This utility IS NOT compatible with SSR.
+ *
+ * @param input - SetCustomUserAgentInput that defines custom state to apply to the specified APIs.
+ */
+export const setCustomUserAgent = (
+	input: SetCustomUserAgentInput
+): (() => void) => {
+	// Save custom user-agent state & increment reference counter
+	// TODO Remove `any` when we upgrade to TypeScript 5.2, see: https://github.com/microsoft/TypeScript/issues/44373
+	customUserAgentState[input.category] = (input.apis as any[]).reduce(
+		(acc: CategoryUserAgentStateMap, api: string) => ({
+			...acc,
+			[api]: {
+				refCount: acc[api]?.refCount ? acc[api].refCount + 1 : 1,
+				additionalDetails: input.additionalDetails,
+			},
+		}),
+		customUserAgentState[input.category] ?? {}
+	);
+
+	// Callback that cleans up state for APIs recorded by this call
+	let cleanUpCallbackCalled = false;
+	const cleanUpCallback = () => {
+		// Only allow the cleanup callback to be called once
+		if (cleanUpCallbackCalled) {
+			return;
+		}
+		cleanUpCallbackCalled = true;
+
+		input.apis.forEach(api => {
+			const apiRefCount = customUserAgentState[input.category][api].refCount;
+
+			if (apiRefCount > 1) {
+				customUserAgentState[input.category][api].refCount = apiRefCount - 1;
+			} else {
+				delete customUserAgentState[input.category][api];
+
+				// Clean up category if no more APIs set
+				if (!Object.keys(customUserAgentState[input.category]).length) {
+					delete customUserAgentState[input.category];
+				}
+			}
+		});
+	};
+
+	return cleanUpCallback;
+};
+
+export const getCustomUserAgent = (
+	category: string,
+	api: string
+): AdditionalDetails | undefined =>
+	customUserAgentState[category]?.[api]?.additionalDetails;

package/src/Platform/detectFramework.ts

@@ -25,7 +25,7 @@ export const detectFramework = (): Framework => {
 			// So we don't need to notify the observers again so the observer
 			// can be removed after the final notice.
 			while (frameworkChangeObservers.length) {
-				frameworkChangeObservers.pop()();
+				frameworkChangeObservers.pop()?.();
 			}
 		} else {
 			// The first run of detectFramework:

package/src/Platform/detection/React.ts

@@ -1,15 +1,15 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { documentExists, processExists, windowExists } from './helpers';
+import { documentExists, processExists } from './helpers';
 
 // Tested with react 18.2 - built using Vite
 
 export function reactWebDetect() {
-	const elementKeyPrefixedWithReact = key => {
+	const elementKeyPrefixedWithReact = (key: string) => {
 		return key.startsWith('_react') || key.startsWith('__react');
 	};
-	const elementIsReactEnabled = element => {
+	const elementIsReactEnabled = (element: Element) => {
 		return Object.keys(element).find(elementKeyPrefixedWithReact);
 	};
 	const allElementsWithId = () => Array.from(document.querySelectorAll('[id]'));
@@ -24,3 +24,5 @@ export function reactSSRDetect() {
 		!!Object.keys(process.env).find(key => key.includes('react'))
 	);
 }
+
+// use the some

package/src/Platform/index.ts

@@ -5,6 +5,7 @@ import { CustomUserAgentDetails, Framework } from './types';
 import { version } from './version';
 import { detectFramework, observeFrameworkChanges } from './detectFramework';
 import { UserAgent as AWSUserAgent } from '@aws-sdk/types';
+import { getCustomUserAgent } from './customUserAgent';
 
 const BASE_USER_AGENT = `aws-amplify`;
 
@@ -39,6 +40,16 @@ export const getAmplifyUserAgentObject = ({
 	}
 	userAgent.push(['framework', detectFramework()]);
 
+	if (category && action) {
+		const customState = getCustomUserAgent(category, action);
+
+		if (customState) {
+			customState.forEach(state => {
+				userAgent.push(state);
+			});
+		}
+	}
+
 	return userAgent;
 };
 
@@ -47,7 +58,9 @@ export const getAmplifyUserAgent = (
 ): string => {
 	const userAgent = getAmplifyUserAgentObject(customUserAgentDetails);
 	const userAgentString = userAgent
-		.map(([agentKey, agentValue]) => `${agentKey}/${agentValue}`)
+		.map(([agentKey, agentValue]) =>
+			agentKey && agentValue ? `${agentKey}/${agentValue}` : agentKey
+		)
 		.join(' ');
 
 	return userAgentString;

package/src/Platform/types.ts

@@ -41,7 +41,7 @@ export enum Category {
 
 export enum AnalyticsAction {
 	Record = '1',
-	UpdateEndpoint = '2',
+	IdentifyUser = '2',
 }
 export enum ApiAction {
 	GraphQl = '1',
@@ -53,50 +53,49 @@ export enum ApiAction {
 	Head = '7',
 }
 export enum AuthAction {
-	// SignUp = '1',
-	// ConfirmSignUp = '2',
-	// ResendSignUp = '3',
-	// SignIn = '4',
-	// GetMFAOptions = '5',
-	// GetPreferredMFA = '6',
-	// SetPreferredMFA = '7',
-	// DisableSMS = '8',
-	// EnableSMS = '9',
-	// SetupTOTP = '10',
-	// VerifyTotpToken = '11',
-	// ConfirmSignIn = '12',
-	// CompleteNewPassword = '13',
-	// SendCustomChallengeAnswer = '14',
-	// DeleteUserAttributes = '15',
-	// DeleteUser = '16',
-	// UpdateUserAttributes = '17',
-	// UserAttributes = '18',
-	// CurrentUserPoolUser = '19',
-	// CurrentAuthenticatedUser = '20',
-	// CurrentSession = '21',
-	// VerifyUserAttribute = '22',
-	// VerifyUserAttributeSubmit = '23',
-	// VerifyCurrentUserAttribute = '24',
-	// VerifyCurrentUserAttributeSubmit = '25',
-	// SignOut = '26',
-	// ChangePassword = '27',
-	// ForgotPassword = '28',
-	// ForgotPasswordSubmit = '29',
+	SignUp = '1',
+	ConfirmSignUp = '2',
+	ResendSignUpCode = '3',
+	SignIn = '4',
+	FetchMFAPreference = '6',
+	UpdateMFAPreference = '7',
+	SetUpTOTP = '10',
+	VerifyTOTPSetup = '11',
+	ConfirmSignIn = '12',
+	DeleteUserAttributes = '15',
+	DeleteUser = '16',
+	UpdateUserAttributes = '17',
+	FetchUserAttributes = '18',
+	ConfirmUserAttribute = '22',
+	SignOut = '26',
+	UpdatePassword = '27',
+	ResetPassword = '28',
+	ConfirmResetPassword = '29',
 	FederatedSignIn = '30',
-	// CurrentUserInfo = '31',
-	// RememberDevice = '32',
-	// ForgetDevice = '33',
-	// FetchDevices = '34',
+	RememberDevice = '32',
+	ForgetDevice = '33',
+	FetchDevices = '34',
+	SendUserAttributeVerificationCode = '35',
+	SignInWithRedirect = '36',
 }
 export enum DataStoreAction {
 	Subscribe = '1',
 	GraphQl = '2',
 }
 export enum GeoAction {
-	None = '0',
+	SearchByText = '0',
+	SearchByCoordinates = '1',
+	SearchForSuggestions = '2',
+	SearchByPlaceId = '3',
+	SaveGeofences = '4',
+	GetGeofence = '5',
+	ListGeofences = '6',
+	DeleteGeofences = '7',
 }
 export enum InAppMessagingAction {
-	None = '0',
+	SyncMessages = '1',
+	IdentifyUser = '2',
+	NotifyMessageInteraction = '3',
 }
 export enum InteractionsAction {
 	None = '0',
@@ -110,15 +109,17 @@ export enum PubSubAction {
 	Subscribe = '1',
 }
 export enum PushNotificationAction {
-	None = '0',
+	InitializePushNotifications = '1',
+	IdentifyUser = '2',
 }
 export enum StorageAction {
-	Put = '1',
-	Get = '2',
+	UploadData = '1',
+	DownloadData = '2',
 	List = '3',
 	Copy = '4',
 	Remove = '5',
 	GetProperties = '6',
+	GetUrl = '7',
 }
 
 type ActionMap = {
@@ -158,3 +159,47 @@ export type CustomUserAgentDetails =
 	| UserAgentDetailsWithCategory<Category.PubSub>
 	| UserAgentDetailsWithCategory<Category.PushNotification>
 	| UserAgentDetailsWithCategory<Category.Storage>;
+
+/**
+ * `refCount` tracks how many consumers have set state for a particular API to avoid it being cleared before all
+ * consumers are done using it.
+ *
+ * Category -> Action -> Custom State
+ */
+export type CategoryUserAgentStateMap = Record<
+	string,
+	{ refCount: number; additionalDetails: AdditionalDetails }
+>;
+export type CustomUserAgentStateMap = Record<string, CategoryUserAgentStateMap>;
+
+export type AdditionalDetails = [string, string?][];
+
+export type StorageUserAgentInput = {
+	category: Category.Storage;
+	apis: StorageAction[];
+	additionalDetails: AdditionalDetails;
+};
+
+export type AuthUserAgentInput = {
+	category: Category.Auth;
+	apis: AuthAction[];
+	additionalDetails: AdditionalDetails;
+};
+
+export type InAppMessagingUserAgentInput = {
+	category: Category.InAppMessaging;
+	apis: InAppMessagingAction[];
+	additionalDetails: AdditionalDetails;
+};
+
+export type GeoUserAgentInput = {
+	category: Category.Geo;
+	apis: GeoAction[];
+	additionalDetails: AdditionalDetails;
+};
+
+export type SetCustomUserAgentInput =
+	| StorageUserAgentInput
+	| AuthUserAgentInput
+	| InAppMessagingUserAgentInput
+	| GeoUserAgentInput;

package/src/Platform/version.ts

@@ -1,2 +1,2 @@
 // generated by genversion
-export const version = '5.3.12-api-v6-models.b3abc9b.0+b3abc9b';
+export const version = '6.0.0';

package/src/Reachability/Reachability.native.ts

@@ -0,0 +1,46 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { Observable } from 'rxjs';
+import { loadNetInfo } from '@aws-amplify/react-native';
+import { ConsoleLogger as Logger } from '../Logger';
+import { NetworkStatus } from './types';
+
+const logger = new Logger('Reachability', 'DEBUG');
+
+export class Reachability {
+	networkMonitor(
+		netInfo?: ReturnType<typeof loadNetInfo>
+	): Observable<NetworkStatus> {
+		/**
+		 * Here netinfo refers to @react-native-community/netinfo
+		 * This is needed in React Native to enable network detection
+		 * We do not import it in Core so that Apps that do not use DataStore
+		 * Do not need to install and link this dependency
+		 * When using Reachability in React Native, pass NetInfo as a param to networkMonitor
+		 */
+		if (!(netInfo && netInfo.addEventListener)) {
+			throw new Error(
+				'NetInfo must be passed to networkMonitor to enable reachability in React Native'
+			);
+		}
+		return new Observable(observer => {
+			logger.log('subscribing to reachability in React Native');
+
+			const unsubscribe = netInfo.addEventListener(
+				({ isInternetReachable }) => {
+					// `isInternetReachable` can sometimes be `null` initially, so we want
+					// to make sure it is a boolean first before sending it to the observer.
+					if (typeof isInternetReachable === 'boolean') {
+						const online = isInternetReachable;
+						logger.log('Notifying reachability change', online);
+						observer.next({ online });
+					}
+				}
+			);
+
+			return () => {
+				unsubscribe();
+			};
+		});
+	}
+}