@aws-amplify/core 5.4.1-unstable.c1fa9c7.8 → 5.5.0

package/src/Platform/detection/ReactNative.ts

@@ -0,0 +1,12 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+// Tested with react-native 0.17.7
+
+export function reactNativeDetect() {
+	return (
+		typeof navigator !== 'undefined' &&
+		typeof navigator.product !== 'undefined' &&
+		navigator.product === 'ReactNative'
+	);
+}

package/src/Platform/detection/Svelte.ts

@@ -0,0 +1,18 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { keyPrefixMatch, processExists, windowExists } from './helpers';
+
+// Tested with svelte 3.59
+
+export function svelteWebDetect() {
+	return windowExists() && keyPrefixMatch(window, '__SVELTE');
+}
+
+export function svelteSSRDetect() {
+	return (
+		processExists() &&
+		typeof process.env !== 'undefined' &&
+		!!Object.keys(process.env).find(key => key.includes('svelte'))
+	);
+}

package/src/Platform/detection/Vue.ts

@@ -0,0 +1,13 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { globalExists, keyPrefixMatch, windowExists } from './helpers';
+
+// Tested with vue 3.3.2
+
+export function vueWebDetect() {
+	return windowExists() && keyPrefixMatch(window, '__VUE');
+}
+export function vueSSRDetect() {
+	return globalExists() && keyPrefixMatch(global, '__VUE');
+}

package/src/Platform/detection/Web.ts

@@ -0,0 +1,8 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { windowExists } from './helpers';
+
+export function webDetect() {
+	return windowExists();
+}

package/src/Platform/detection/helpers.ts

@@ -0,0 +1,26 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export const globalExists = () => {
+	return typeof global !== 'undefined';
+};
+
+export const globalThisExists = () => {
+	return typeof globalThis !== 'undefined';
+};
+
+export const windowExists = () => {
+	return typeof window !== 'undefined';
+};
+
+export const documentExists = () => {
+	return typeof document !== 'undefined';
+};
+
+export const processExists = () => {
+	return typeof process !== 'undefined';
+};
+
+export const keyPrefixMatch = (object: object, prefix: string) => {
+	return !!Object.keys(object).find(key => key.startsWith(prefix));
+};

package/src/Platform/detection/index.ts

@@ -0,0 +1,48 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { Framework } from '../types';
+
+import { reactWebDetect, reactSSRDetect } from './React';
+import { vueWebDetect, vueSSRDetect } from './Vue';
+import { svelteWebDetect, svelteSSRDetect } from './Svelte';
+import { nextWebDetect, nextSSRDetect } from './Next';
+import { nuxtWebDetect, nuxtSSRDetect } from './Nuxt';
+import { angularWebDetect, angularSSRDetect } from './Angular';
+import { reactNativeDetect } from './ReactNative';
+import { expoDetect } from './Expo';
+import { webDetect } from './Web';
+
+type PlatformDetectionEntry = {
+	platform: Framework;
+	detectionMethod: () => boolean;
+};
+
+// These are in the order of detection where when both are detectable, the early Framework will be reported
+const detectionMap: PlatformDetectionEntry[] = [
+	// First, detect mobile
+	{ platform: Framework.Expo, detectionMethod: expoDetect },
+	{ platform: Framework.ReactNative, detectionMethod: reactNativeDetect },
+	// Next, detect web frameworks
+	{ platform: Framework.NextJs, detectionMethod: nextWebDetect },
+	{ platform: Framework.Nuxt, detectionMethod: nuxtWebDetect },
+	{ platform: Framework.Angular, detectionMethod: angularWebDetect },
+	{ platform: Framework.React, detectionMethod: reactWebDetect },
+	{ platform: Framework.VueJs, detectionMethod: vueWebDetect },
+	{ platform: Framework.Svelte, detectionMethod: svelteWebDetect },
+	{ platform: Framework.WebUnknown, detectionMethod: webDetect },
+	// Last, detect ssr frameworks
+	{ platform: Framework.NextJsSSR, detectionMethod: nextSSRDetect },
+	{ platform: Framework.NuxtSSR, detectionMethod: nuxtSSRDetect },
+	{ platform: Framework.ReactSSR, detectionMethod: reactSSRDetect },
+	{ platform: Framework.VueJsSSR, detectionMethod: vueSSRDetect },
+	{ platform: Framework.AngularSSR, detectionMethod: angularSSRDetect },
+	{ platform: Framework.SvelteSSR, detectionMethod: svelteSSRDetect },
+];
+
+export function detect() {
+	return (
+		detectionMap.find(detectionEntry => detectionEntry.detectionMethod())
+			?.platform || Framework.ServerSideUnknown
+	);
+}

package/src/Platform/index.ts

@@ -1,30 +1,51 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
+
+import { CustomUserAgentDetails, Framework } from './types';
 import { version } from './version';
+import { detectFramework, observeFrameworkChanges } from './detectFramework';
+import { UserAgent as AWSUserAgent } from '@aws-sdk/types';
 
-const BASE_USER_AGENT = `aws-amplify/${version}`;
+const BASE_USER_AGENT = `aws-amplify`;
 
-export const Platform = {
-	userAgent: `${BASE_USER_AGENT} js`,
-	product: '',
-	navigator: null,
-	isReactNative: false,
-};
-if (typeof navigator !== 'undefined' && navigator.product) {
-	Platform.product = navigator.product || '';
-	Platform.navigator = navigator || null;
-	switch (navigator.product) {
-		case 'ReactNative':
-			Platform.userAgent = `${BASE_USER_AGENT} react-native`;
-			Platform.isReactNative = true;
-			break;
-		default:
-			Platform.userAgent = `${BASE_USER_AGENT} js`;
-			Platform.isReactNative = false;
-			break;
+class PlatformBuilder {
+	userAgent = `${BASE_USER_AGENT}/${version}`;
+	get framework() {
+		return detectFramework();
+	}
+
+	get isReactNative() {
+		return this.framework === Framework.ReactNative;
+	}
+
+	observeFrameworkChanges(fcn: () => void) {
+		observeFrameworkChanges(fcn);
 	}
 }
 
-export const getAmplifyUserAgent = (content?: string) => {
-	return `${Platform.userAgent}${content ? content : ''}`;
+export const Platform = new PlatformBuilder();
+
+export const getAmplifyUserAgent = ({
+	category,
+	action,
+	framework,
+}: CustomUserAgentDetails = {}): AWSUserAgent => {
+	const userAgent: AWSUserAgent = [[BASE_USER_AGENT, version]];
+	if (category) {
+		userAgent.push([category, action]);
+	}
+	userAgent.push(['framework', detectFramework()]);
+
+	return userAgent;
+};
+
+export const getAmplifyUserAgentString = (
+	customUserAgentDetails?: CustomUserAgentDetails
+): string => {
+	const userAgent = getAmplifyUserAgent(customUserAgentDetails);
+	const userAgentString = userAgent
+		.map(([agentKey, agentValue]) => `${agentKey}/${agentValue}`)
+		.join(' ');
+
+	return userAgentString;
 };

package/src/Platform/types.ts

@@ -0,0 +1,160 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export enum Framework {
+	// < 100 - Web frameworks
+	WebUnknown = '0',
+	React = '1',
+	NextJs = '2',
+	Angular = '3',
+	VueJs = '4',
+	Nuxt = '5',
+	Svelte = '6',
+
+	// 100s - Server side frameworks
+	ServerSideUnknown = '100',
+	ReactSSR = '101',
+	NextJsSSR = '102',
+	AngularSSR = '103',
+	VueJsSSR = '104',
+	NuxtSSR = '105',
+	SvelteSSR = '106',
+
+	// 200s - Mobile framework
+	ReactNative = '201',
+	Expo = '202',
+}
+
+export enum Category {
+	API = 'api',
+	Auth = 'auth',
+	Analytics = 'analytics',
+	DataStore = 'datastore',
+	Geo = 'geo',
+	InAppMessaging = 'inappmessaging',
+	Interactions = 'interactions',
+	Predictions = 'predictions',
+	PubSub = 'pubsub',
+	PushNotification = 'pushnotification',
+	Storage = 'storage',
+}
+
+export enum AnalyticsAction {
+	Record = '1',
+	UpdateEndpoint = '2',
+}
+export enum ApiAction {
+	GraphQl = '1',
+	Get = '2',
+	Post = '3',
+	Put = '4',
+	Patch = '5',
+	Del = '6',
+	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',
+	FederatedSignIn = '30',
+	// CurrentUserInfo = '31',
+	// RememberDevice = '32',
+	// ForgetDevice = '33',
+	// FetchDevices = '34',
+}
+export enum DataStoreAction {
+	Subscribe = '1',
+	GraphQl = '2',
+}
+export enum GeoAction {
+	None = '0',
+}
+export enum InAppMessagingAction {
+	None = '0',
+}
+export enum InteractionsAction {
+	None = '0',
+}
+export enum PredictionsAction {
+	Convert = '1',
+	Identify = '2',
+	Interpret = '3',
+}
+export enum PubSubAction {
+	Subscribe = '1',
+}
+export enum PushNotificationAction {
+	None = '0',
+}
+export enum StorageAction {
+	Put = '1',
+	Get = '2',
+	List = '3',
+	Copy = '4',
+	Remove = '5',
+	GetProperties = '6',
+}
+
+type ActionMap = {
+	[Category.Auth]: AuthAction;
+	[Category.API]: ApiAction;
+	[Category.Analytics]: AnalyticsAction;
+	[Category.DataStore]: DataStoreAction;
+	[Category.Geo]: GeoAction;
+	[Category.InAppMessaging]: InAppMessagingAction;
+	[Category.Interactions]: InteractionsAction;
+	[Category.Predictions]: PredictionsAction;
+	[Category.PubSub]: PubSubAction;
+	[Category.PushNotification]: PushNotificationAction;
+	[Category.Storage]: StorageAction;
+};
+
+type UserAgentDetailsWithCategory<T extends Category> =
+	CustomUserAgentDetailsBase & {
+		category: T;
+		action: T extends keyof ActionMap ? ActionMap[T] : never;
+	};
+
+type CustomUserAgentDetailsBase = {
+	framework?: Framework;
+};
+
+export type CustomUserAgentDetails =
+	| (CustomUserAgentDetailsBase & { category?: never; action?: never })
+	| UserAgentDetailsWithCategory<Category.API>
+	| UserAgentDetailsWithCategory<Category.Auth>
+	| UserAgentDetailsWithCategory<Category.Analytics>
+	| UserAgentDetailsWithCategory<Category.DataStore>
+	| UserAgentDetailsWithCategory<Category.Geo>
+	| UserAgentDetailsWithCategory<Category.Interactions>
+	| UserAgentDetailsWithCategory<Category.InAppMessaging>
+	| UserAgentDetailsWithCategory<Category.Predictions>
+	| UserAgentDetailsWithCategory<Category.PubSub>
+	| UserAgentDetailsWithCategory<Category.PushNotification>
+	| UserAgentDetailsWithCategory<Category.Storage>;

package/src/Platform/version.ts

@@ -1,2 +1,2 @@
 // generated by genversion
-export const version = '5.2.8-unstable.c1fa9c7.2+c1fa9c736';
+export const version = '5.3.0';

package/src/index.ts

@@ -35,7 +35,27 @@ export { ServiceWorker } from './ServiceWorker';
 export { ICredentials } from './types';
 export { StorageHelper, MemoryStorage } from './StorageHelper';
 export { UniversalStorage } from './UniversalStorage';
-export { Platform, getAmplifyUserAgent } from './Platform';
+export {
+	Platform,
+	getAmplifyUserAgent,
+	getAmplifyUserAgentString,
+} from './Platform';
+export {
+	ApiAction,
+	AuthAction,
+	AnalyticsAction,
+	Category,
+	CustomUserAgentDetails,
+	DataStoreAction,
+	Framework,
+	GeoAction,
+	InteractionsAction,
+	InAppMessagingAction,
+	PredictionsAction,
+	PubSubAction,
+	PushNotificationAction,
+	StorageAction,
+} from './Platform/types';
 export {
 	INTERNAL_AWS_APPSYNC_REALTIME_PUBSUB_PROVIDER,
 	USER_AGENT_HEADER,