@aws-amplify/core 5.6.0 → 5.6.1-v5-user-agent-for-ui.f058eee.7

package/src/Platform/index.ts

@@ -4,7 +4,7 @@
 import { CustomUserAgentDetails, Framework } from './types';
 import { version } from './version';
 import { detectFramework, observeFrameworkChanges } from './detectFramework';
-import { UserAgent as AWSUserAgent } from '@aws-sdk/types';
+import type { UserAgent as AWSUserAgent } from '@aws-sdk/types';
 
 const BASE_USER_AGENT = `aws-amplify`;
 
@@ -32,12 +32,17 @@ export const getAmplifyUserAgentObject = ({
 	category,
 	action,
 	framework,
+	additionalInfo,
 }: CustomUserAgentDetails = {}): AWSUserAgent => {
-	const userAgent: AWSUserAgent = [[BASE_USER_AGENT, version]];
+	let userAgent: AWSUserAgent = [[BASE_USER_AGENT, version]];
 	if (category) {
 		userAgent.push([category, action]);
 	}
-	userAgent.push(['framework', detectFramework()]);
+	userAgent.push(['framework', framework || detectFramework()]);
+
+	if (additionalInfo) {
+		userAgent = userAgent.concat(additionalInfo);
+	}
 
 	return userAgent;
 };

package/src/Platform/types.ts

@@ -1,5 +1,6 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
+import type { UserAgent as AWSUserAgent } from '@aws-sdk/types';
 
 export enum Framework {
 	// < 100 - Web frameworks
@@ -93,10 +94,19 @@ export enum DataStoreAction {
 	GraphQl = '2',
 }
 export enum GeoAction {
-	None = '0',
+	SearchByText = '1',
+	SearchForSuggestions = '2',
+	SearchByPlaceId = '3',
+	SearchByCoordinates = '4',
+	SaveGeofences = '5',
+	GetGeofence = '6',
+	ListGeofences = '7',
+	DeleteGeofences = '8',
 }
 export enum InAppMessagingAction {
 	None = '0',
+	SyncMessages = '1',
+	IdentifyUser = '2',
 }
 export enum InteractionsAction {
 	None = '0',
@@ -119,6 +129,7 @@ export enum StorageAction {
 	Copy = '4',
 	Remove = '5',
 	GetProperties = '6',
+	Cancel = '7',
 }
 
 type ActionMap = {
@@ -143,8 +154,15 @@ type UserAgentDetailsWithCategory<T extends Category> =
 
 type CustomUserAgentDetailsBase = {
 	framework?: Framework;
+	// DO NOT REMOVE:
+	// Used by other Amplify teams to pass information to the custom user agent
+	/** Accepts an array of arrays with exactly 1 or 2 values and translates 
+	those arrays to "item" or "item1/item2" strings on the custom user agent */
+	additionalInfo?: AWSUserAgent;
 };
 
+// DO NOT MAKE ANY PROP REQUIRED on CustomUserAgentDetails
+// This object is used by other Amplify teams to pass information to the user agent
 export type CustomUserAgentDetails =
 	| (CustomUserAgentDetailsBase & { category?: never; action?: never })
 	| UserAgentDetailsWithCategory<Category.API>

package/src/Platform/version.ts

@@ -1,2 +1,2 @@
 // generated by genversion
-export const version = '5.3.4';
+export const version = '5.3.5-v5-user-agent-for-ui.f058eee.7+f058eee75';