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

package/src/I18n/index.ts

@@ -4,19 +4,16 @@
 import { I18n as I18nClass } from './I18n';
 
 import { ConsoleLogger as Logger } from '../Logger';
-import { I18nOptions } from './types';
-import { asserts } from '../Util/errors/AssertError';
-import { I18N_EXCEPTION } from '../Util/Constants';
+import { I18nConfig } from './types';
+import { assert, I18nErrorCode } from './errorHelpers';
 
 const logger = new Logger('I18n');
 
-let _config: I18nOptions = { language: null };
+let _config: I18nConfig = { language: null };
 let _i18n: I18nClass | null = null;
 
 /**
  * Export I18n APIs
- * 
- * @deprecated The I18n utility is on a deprecation path and will be removed in a future version of Amplify.
  */
 export class I18n {
 	/**
@@ -46,8 +43,6 @@ export class I18n {
 	 * @static
 	 * @method
 	 * Create an instance of I18n for the library
-	 * 
-	 * @deprecated The I18n utility is on a deprecation path and will be removed in a future version of Amplify.
 	 */
 	static createInstance() {
 		logger.debug('create I18n instance');
@@ -61,15 +56,11 @@ export class I18n {
 	 * @static @method
 	 * Explicitly setting language
 	 * @param {String} lang
-	 * 
-	 * @deprecated The I18n utility is on a deprecation path and will be removed in a future version of Amplify.
 	 */
 	static setLanguage(lang: string) {
 		I18n.checkConfig();
-		asserts(!!_i18n, {
-			name: I18N_EXCEPTION,
-			message: 'I18N is not configured',
-		});
+		assert(!!_i18n, I18nErrorCode.NotConfigured);
+
 		return _i18n.setLanguage(lang);
 	}
 
@@ -78,17 +69,12 @@ export class I18n {
 	 * Get value
 	 * @param {String} key
 	 * @param {String} defVal - Default value
-	 * 
-	 * @deprecated The I18n utility is on a deprecation path and will be removed in a future version of Amplify.
 	 */
 	static get(key: string, defVal?: string) {
 		if (!I18n.checkConfig()) {
 			return typeof defVal === 'undefined' ? key : defVal;
 		}
-		asserts(!!_i18n, {
-			name: I18N_EXCEPTION,
-			message: 'I18N is not configured',
-		});
+		assert(!!_i18n, I18nErrorCode.NotConfigured);
 
 		return _i18n.get(key, defVal);
 	}
@@ -99,18 +85,13 @@ export class I18n {
 	 * Add vocabularies for one language
 	 * @param {String} langurage - Language of the dictionary
 	 * @param {Object} vocabularies - Object that has key-value as dictionary entry
-	 * 
-	 * @deprecated The I18n utility is on a deprecation path and will be removed in a future version of Amplify.
 	 */
 	static putVocabulariesForLanguage(
 		language: string,
 		vocabularies: Record<string, string>
 	) {
 		I18n.checkConfig();
-		asserts(!!_i18n, {
-			name: I18N_EXCEPTION,
-			message: 'I18N is not configured',
-		});
+		assert(!!_i18n, I18nErrorCode.NotConfigured);
 
 		return _i18n.putVocabulariesForLanguage(language, vocabularies);
 	}
@@ -121,15 +102,10 @@ export class I18n {
 	 * Add vocabularies for one language
 	 * @param {Object} vocabularies - Object that has language as key,
 	 *                                vocabularies of each language as value
-	 * 
-	 * @deprecated The I18n utility is on a deprecation path and will be removed in a future version of Amplify.
 	 */
-	static putVocabularies(vocabularies: Record<string, string>) {
+	static putVocabularies(vocabularies: Record<string, Record<string, string>>) {
 		I18n.checkConfig();
-		asserts(!!_i18n, {
-			name: I18N_EXCEPTION,
-			message: 'I18N is not configured',
-		});
+		assert(!!_i18n, I18nErrorCode.NotConfigured);
 
 		return _i18n.putVocabularies(vocabularies);
 	}

package/src/I18n/types.ts

@@ -1,9 +1,6 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-/**
- * @deprecated The I18n utility is on a deprecation path and will be removed in a future version of Amplify.
- */
-export class I18nOptions {
+export class I18nConfig {
 	language = null;
 }

package/src/Logger/ConsoleLogger.ts

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { LoggingProvider, InputLogEvent } from '../types';
-import { AWS_CLOUDWATCH_CATEGORY } from '../Util/Constants';
+import { AWS_CLOUDWATCH_CATEGORY } from '../constants';
 import { Logger } from './logger-interface';
 
 const LOG_LEVELS: Record<string, number> = {

package/src/{Util → Mutex}/Mutex.ts

@@ -24,25 +24,9 @@
  * THE SOFTWARE.
  */
 
-interface MutexInterface {
-	acquire(): Promise<MutexInterface.Releaser>;
+import { MutexInterface } from './types';
 
-	runExclusive<T>(callback: MutexInterface.Worker<T>): Promise<T>;
-
-	isLocked(): boolean;
-}
-
-namespace MutexInterface {
-	export interface Releaser {
-		(): void;
-	}
-
-	export interface Worker<T> {
-		(): Promise<T> | T;
-	}
-}
-
-class Mutex implements MutexInterface {
+export class Mutex implements MutexInterface {
 	isLocked(): boolean {
 		return this._pending;
 	}
@@ -92,5 +76,3 @@ class Mutex implements MutexInterface {
 	private _queue: Array<(release: MutexInterface.Releaser) => void> = [];
 	private _pending = false;
 }
-
-export default Mutex;

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/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 = '6.0.1-preview-testing.be90020.0+be90020';
+export const version = '6.0.1-ssr-api.df60e41.0+df60e41';

package/src/{Util → Reachability}/Reachability.native.ts

@@ -1,17 +1,16 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import Observable from 'zen-observable-ts';
+import { Observable } from 'rxjs';
+import { loadNetInfo } from '@aws-amplify/react-native';
 import { ConsoleLogger as Logger } from '../Logger';
-import type NetInfo from '@react-native-community/netinfo';
+import { NetworkStatus } from './types';
 
 const logger = new Logger('Reachability', 'DEBUG');
 
-type NetworkStatus = {
-	online: boolean;
-};
-
-export default class ReachabilityNavigator implements Reachability {
-	networkMonitor(netInfo?: typeof NetInfo): Observable<NetworkStatus> {
+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
@@ -45,7 +44,3 @@ export default class ReachabilityNavigator implements Reachability {
 		});
 	}
 }
-
-interface Reachability {
-	networkMonitor(netInfo?: typeof NetInfo): Observable<NetworkStatus>;
-}

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;
+};