@aws-amplify/notifications 1.6.6-api-v6-models.3f48fe3.0 → 2.0.1-console-preview.11cf989.0

package/package.json

@@ -1,78 +1,129 @@
 {
-	"name": "@aws-amplify/notifications",
-	"version": "1.6.6-api-v6-models.3f48fe3.0+3f48fe3",
-	"description": "Notifications category of aws-amplify",
-	"main": "./lib/index.js",
-	"module": "./lib-esm/index.js",
-	"typings": "./lib-esm/index.d.ts",
-	"sideEffects": [
-		"./lib/Notifications.js",
-		"./lib-esm/Notifications.js"
-	],
-	"publishConfig": {
-		"access": "public"
-	},
-	"scripts": {
-		"test": "npm run lint && npm run test:default && npm run test:native",
-		"test:default": "jest -w 1 --coverage",
-		"test:native": "jest -w 1 --coverage --config=jest.native.config.js --coverageDirectory=coverage-native",
-		"test:watch": "tslint 'src/**/*.ts' && jest -w 1 --watch",
-		"test:size": "size-limit",
-		"build-with-test": "npm run clean && npm test && tsc && webpack",
-		"build:cjs": "node ./build es5 && webpack && webpack --config ./webpack.config.dev.js",
-		"build:esm": "node ./build es6",
-		"build:cjs:watch": "node ./build es5 --watch",
-		"build:esm:watch": "node ./build es6 --watch",
-		"build": "npm run clean && npm run build:esm && npm run build:cjs",
-		"clean": "npm run clean:size && rimraf lib-esm lib dist",
-		"clean:size": "rimraf dual-publish-tmp tmp*",
-		"format": "echo \"Not implemented\"",
-		"lint": "tslint 'src/**/*.ts' && npm run ts-coverage",
-		"ts-coverage": "typescript-coverage-report -p ./tsconfig.build.json -t 88.21"
-	},
-	"react-native": {
-		"./lib/index": "./lib-esm/index.js"
-	},
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/aws-amplify/amplify-js.git"
-	},
-	"author": "Amazon Web Services",
-	"license": "Apache-2.0",
-	"bugs": {
-		"url": "https://github.com/aws/aws-amplify/issues"
-	},
-	"homepage": "https://docs.amplify.aws/",
-	"files": [
-		"lib",
-		"lib-esm",
-		"src"
-	],
-	"dependencies": {
-		"@aws-amplify/cache": "5.1.12-api-v6-models.3f48fe3.0+3f48fe3",
-		"@aws-amplify/core": "5.8.6-api-v6-models.3f48fe3.0+3f48fe3",
-		"@aws-amplify/rtn-push-notification": "1.1.8-api-v6-models.3f48fe3.0+3f48fe3",
-		"lodash": "^4.17.21",
-		"uuid": "^3.2.1"
-	},
-	"devDependencies": {
-		"@babel/plugin-proposal-class-properties": "^7.0.0",
-		"@babel/plugin-proposal-private-methods": "^7.0.0",
-		"@babel/plugin-proposal-private-property-in-object": "^7.0.0"
-	},
-	"size-limit": [
-		{
-			"name": "Notifications (top-level class)",
-			"path": "./lib-esm/index.js",
-			"import": "{ Amplify, Notifications }",
-			"limit": "30.95 kB"
-		},
-		{
-			"name": "Notifications (with Analytics)",
-			"path": "./lib-esm/index.js",
-			"import": "{ Amplify, Notifications, Analytics }",
-			"limit": "30.95 kB"
-		}
-	],
-	"gitHead": "3f48fe305e44b96113ec44c0ed46f41dee97ce05"
+  "name": "@aws-amplify/notifications",
+  "version": "2.0.1-console-preview.11cf989.0+11cf989",
+  "description": "Notifications category of aws-amplify",
+  "main": "./lib/index.js",
+  "module": "./lib-esm/index.js",
+  "typings": "./lib-esm/index.d.ts",
+  "sideEffects": [
+    "./lib/Notifications.js",
+    "./lib-esm/Notifications.js"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "test": "npm run lint && npm run test:default && npm run test:native",
+    "test:default": "jest -w 1 --coverage",
+    "test:native": "jest -w 1 --coverage --config=jest.native.config.js --coverageDirectory=coverage-native",
+    "test:watch": "tslint 'src/**/*.ts' && jest -w 1 --watch",
+    "test:size": "size-limit",
+    "build-with-test": "npm run clean && npm test && tsc && webpack",
+    "build:cjs": "node ./build es5 && webpack && webpack --config ./webpack.config.dev.js",
+    "build:esm": "node ./build es6",
+    "build:cjs:watch": "node ./build es5 --watch",
+    "build:esm:watch": "node ./build es6 --watch",
+    "build": "npm run clean && npm run build:esm && npm run build:cjs",
+    "clean": "npm run clean:size && rimraf lib-esm lib dist",
+    "clean:size": "rimraf dual-publish-tmp tmp*",
+    "format": "echo \"Not implemented\"",
+    "lint": "tslint 'src/**/*.ts' && npm run ts-coverage",
+    "ts-coverage": "typescript-coverage-report -p ./tsconfig.build.json -t 88.21"
+  },
+  "typesVersions": {
+    ">=4.0": {
+      "*": [
+        "./lib-esm/index.d.ts"
+      ],
+      "in-app-messaging": [
+        "./lib-esm/inAppMessaging/providers/index.d.ts"
+      ],
+      "push-notifications": [
+        "./lib-esm/pushNotifications/providers/index.d.ts"
+      ],
+      "in-app-messaging/pinpoint": [
+        "./lib-esm/inAppMessaging/providers/pinpoint/index.d.ts"
+      ],
+      "push-notifications/pinpoint": [
+        "./lib-esm/pushNotifications/providers/pinpoint/index.d.ts"
+      ]
+    }
+  },
+  "exports": {
+    ".": {
+      "types": "./lib-esm/index.d.ts",
+      "import": "./lib-esm/index.js",
+      "require": "./lib/index.js"
+    },
+    "./in-app-messaging": {
+      "types": "./lib-esm/inAppMessaging/providers/index.d.ts",
+      "import": "./lib-esm/inAppMessaging/providers/index.js",
+      "require": "./lib/inAppMessaging/providers/index.js"
+    },
+    "./push-notifications": {
+      "types": "./lib-esm/pushNotifications/providers/index.d.ts",
+      "import": "./lib-esm/pushNotifications/providers/index.js",
+      "require": "./lib/pushNotifications/providers/index.js"
+    },
+    "./in-app-messaging/pinpoint": {
+      "types": "./lib-esm/inAppMessaging/providers/pinpoint/index.d.ts",
+      "import": "./lib-esm/inAppMessaging/providers/pinpoint/index.js",
+      "require": "./lib/inAppMessaging/providers/pinpoint/index.js"
+    },
+    "./push-notifications/pinpoint": {
+      "types": "./lib-esm/pushNotifications/providers/pinpoint/index.d.ts",
+      "import": "./lib-esm/pushNotifications/providers/pinpoint/index.js",
+      "require": "./lib/pushNotifications/providers/pinpoint/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "react-native": {
+    "./lib/index": "./lib-esm/index.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/aws-amplify/amplify-js.git"
+  },
+  "author": "Amazon Web Services",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/aws/aws-amplify/issues"
+  },
+  "homepage": "https://docs.amplify.aws/",
+  "files": [
+    "lib",
+    "lib-esm",
+    "src"
+  ],
+  "dependencies": {
+    "@aws-amplify/rtn-push-notification": "1.1.7",
+    "lodash": "^4.17.21",
+    "uuid": "^9.0.0"
+  },
+  "peerDependencies": {
+    "@aws-amplify/core": "6.0.1-console-preview.11cf989.0+11cf989"
+  },
+  "devDependencies": {
+    "@aws-amplify/core": "6.0.1-console-preview.11cf989.0+11cf989",
+    "@babel/core": "7.15.5",
+    "@babel/plugin-proposal-class-properties": "^7.0.0",
+    "@babel/plugin-proposal-private-methods": "^7.0.0",
+    "@babel/plugin-proposal-private-property-in-object": "^7.0.0",
+    "metro-react-native-babel-preset": "^0.66.2"
+  },
+  "size-limit": [
+    {
+      "name": "Notifications (top-level class)",
+      "path": "./lib-esm/index.js",
+      "import": "{ Amplify, Notifications }",
+      "limit": "29.95 kB"
+    },
+    {
+      "name": "Notifications (with Analytics)",
+      "path": "./lib-esm/index.js",
+      "import": "{ Amplify, Notifications, Analytics }",
+      "limit": "29.95 kB"
+    }
+  ],
+  "gitHead": "11cf9890e0229d7f36a7b2375e57bc0decf9935a"
 }

package/src/common/AWSPinpointProviderCommon/index.ts

@@ -5,15 +5,13 @@ import {
 	Category,
 	ClientDevice,
 	ConsoleLogger,
-	Credentials,
 	CustomUserAgentDetails,
 	getAmplifyUserAgent,
 	InAppMessagingAction,
 	PushNotificationAction,
-	StorageHelper,
-	transferKeyToUpperCase,
-} from '@aws-amplify/core';
-import { Cache } from '@aws-amplify/cache';
+} from '@aws-amplify/core/internals/utils';
+import { Cache, fetchAuthSession } from '@aws-amplify/core';
+
 import {
 	Event as AWSPinpointAnalyticsEvent,
 	putEvents,
@@ -44,7 +42,7 @@ export default abstract class AWSPinpointProviderCommon
 	protected logger: ConsoleLogger;
 
 	constructor(logger) {
-		this.config = { storage: new StorageHelper().getStorage() };
+		// this.config = { storage: new StorageHelper().getStorage() };
 		this.clientInfo = ClientDevice.clientInfo() ?? {};
 		this.logger = logger;
 	}
@@ -208,12 +206,12 @@ export default abstract class AWSPinpointProviderCommon
 						Model: model,
 						ModelVersion: version,
 						Platform: platform,
-						...transferKeyToUpperCase({
+						...this.transferKeyToUpperCase({
 							...endpointInfo.demographic,
 							...demographic,
 						}),
 					},
-					Location: transferKeyToUpperCase({
+					Location: this.transferKeyToUpperCase({
 						...endpointInfo.location,
 						...location,
 					}),
@@ -268,12 +266,12 @@ export default abstract class AWSPinpointProviderCommon
 
 	private getCredentials = async () => {
 		try {
-			const credentials = await Credentials.get();
-			if (!credentials) {
+			const session = await fetchAuthSession();
+			if (!session.credentials) {
 				this.logger.debug('no credentials found');
 				return null;
 			}
-			return Credentials.shear(credentials);
+			return { ...session.credentials, identityId: session.identityId };
 		} catch (err) {
 			this.logger.error('Error getting credentials:', err);
 			return null;
@@ -288,4 +286,20 @@ export default abstract class AWSPinpointProviderCommon
 			);
 		}
 	};
+
+	/**
+	 * transfer the first letter of the keys to lowercase
+	 * @param {Object} obj - the object need to be transferred
+	 */
+	private transferKeyToUpperCase = (obj: Record<string, any>) => {
+		const ret: Record<string, any> = {};
+
+		for (const key in obj) {
+			if (obj.hasOwnProperty(key)) {
+				const transferredKey = key[0].toUpperCase() + key.slice(1);
+				ret[transferredKey] = this.transferKeyToUpperCase(obj[key]);
+			}
+		}
+		return ret;
+	};
 }

package/src/common/eventListeners/types.ts

@@ -1,8 +1,8 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { InAppMessageInteractionEvent } from '../../InAppMessaging/types';
-import { PushNotificationEvent } from '../../PushNotification/types';
+import { InAppMessageInteractionEvent } from '../../inAppMessaging/types';
+import { PushNotificationEvent } from '../../pushNotifications/types';
 
 export interface EventListener<EventHandler extends Function> {
 	handleEvent: EventHandler;

package/src/common/index.ts

@@ -2,7 +2,6 @@
 // SPDX-License-Identifier: Apache-2.0
 
 export { default as AWSPinpointProviderCommon } from './AWSPinpointProviderCommon';
-export { AMPLIFY_SYMBOL } from './constants';
 export {
 	addEventListener,
 	notifyEventListeners,

package/src/inAppMessaging/errors/InAppMessagingError.ts

@@ -0,0 +1,21 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	AmplifyError,
+	AmplifyErrorParams,
+} from '@aws-amplify/core/internals/utils';
+
+/**
+ * @internal
+ */
+export class InAppMessagingError extends AmplifyError {
+	constructor(params: AmplifyErrorParams) {
+		super(params);
+
+		// Hack for making the custom error class work when transpiled to es5
+		// TODO: Delete the following 2 lines after we change the build target to >= es2015
+		this.constructor = InAppMessagingError;
+		Object.setPrototypeOf(this, InAppMessagingError.prototype);
+	}
+}

package/src/inAppMessaging/errors/assertServiceError.ts

@@ -0,0 +1,24 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	AmplifyErrorCode,
+	ServiceError,
+} from '@aws-amplify/core/internals/utils';
+import { InAppMessagingError } from './InAppMessagingError';
+
+export function assertServiceError(
+	error: unknown
+): asserts error is ServiceError {
+	if (
+		!error ||
+		(error as ServiceError).name === 'Error' ||
+		error instanceof TypeError
+	) {
+		throw new InAppMessagingError({
+			name: AmplifyErrorCode.Unknown,
+			message: 'An unknown error has ocurred.',
+			underlyingError: error,
+		});
+	}
+}

package/src/inAppMessaging/errors/assertValidationError.ts

@@ -0,0 +1,22 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { InAppMessagingError } from './InAppMessagingError';
+import {
+	InAppMessagingValidationErrorCode,
+	validationErrorMap,
+} from './validation';
+
+/**
+ * @internal
+ */
+export function assertValidationError(
+	assertion: boolean,
+	name: InAppMessagingValidationErrorCode
+): asserts assertion {
+	const { message, recoverySuggestion } = validationErrorMap[name];
+
+	if (!assertion) {
+		throw new InAppMessagingError({ name, message, recoverySuggestion });
+	}
+}

package/src/inAppMessaging/errors/index.ts

@@ -0,0 +1,10 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { InAppMessagingError } from './InAppMessagingError';
+export { assertValidationError } from './assertValidationError';
+export { assertServiceError } from './assertServiceError';
+export {
+	InAppMessagingValidationErrorCode,
+	validationErrorMap,
+} from './validation';

package/src/inAppMessaging/errors/validation.ts

@@ -0,0 +1,27 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { AmplifyErrorMap } from '@aws-amplify/core/internals/utils';
+
+export enum InAppMessagingValidationErrorCode {
+	NoAppId = 'NoAppId',
+	NoCredentials = 'NoCredentials',
+	NoRegion = 'NoRegion',
+	NoEndpointId = 'NoEndpointId',
+}
+
+export const validationErrorMap: AmplifyErrorMap<InAppMessagingValidationErrorCode> =
+	{
+		[InAppMessagingValidationErrorCode.NoAppId]: {
+			message: 'Missing application id.',
+		},
+		[InAppMessagingValidationErrorCode.NoCredentials]: {
+			message: 'Credentials should not be empty.',
+		},
+		[InAppMessagingValidationErrorCode.NoRegion]: {
+			message: 'Missing region.',
+		},
+		[InAppMessagingValidationErrorCode.NoEndpointId]: {
+			message: 'Could not find or create EndpointId.',
+		},
+	};

package/src/{InAppMessaging → inAppMessaging}/index.ts

@@ -1,7 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-export { default } from './InAppMessaging';
+export { identifyUser, syncMessages } from './providers/pinpoint';
 export {
 	InAppMessage,
 	InAppMessageAction,

package/src/{InAppMessaging/Providers → inAppMessaging/providers}/index.ts

@@ -1,4 +1,4 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-export { default as AWSPinpointProvider } from './AWSPinpointProvider';
+export { identifyUser, syncMessages } from './pinpoint/apis';

package/src/inAppMessaging/providers/pinpoint/apis/identifyUser.ts

@@ -0,0 +1,11 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { UserInfo } from '../../../../types';
+
+export function identifyUser(
+	userId: string,
+	userInfo: UserInfo
+): Promise<void> {
+	throw new Error('WIP');
+}

package/src/inAppMessaging/providers/pinpoint/apis/index.ts

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

package/src/inAppMessaging/providers/pinpoint/apis/syncMessages.ts

@@ -0,0 +1,108 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	InAppMessagingAction,
+	ConsoleLogger as Logger,
+} from '@aws-amplify/core/internals/utils';
+import {
+	updateEndpoint,
+	getEndpointId,
+} from '@aws-amplify/core/internals/providers/pinpoint';
+import { defaultStorage } from '@aws-amplify/core';
+import {
+	resolveConfig,
+	resolveCredentials,
+	getInAppMessagingUserAgentString,
+	STORAGE_KEY_SUFFIX,
+	PINPOINT_KEY_PREFIX,
+	CATEGORY,
+	CHANNEL_TYPE,
+} from '../utils';
+import {
+	getInAppMessages,
+	GetInAppMessagesInput,
+	GetInAppMessagesOutput,
+} from '@aws-amplify/core/internals/aws-clients/pinpoint';
+import {
+	InAppMessagingValidationErrorCode,
+	assertServiceError,
+	assertValidationError,
+} from '../../../errors';
+
+/**
+ * Fetch and persist messages from Pinpoint campaigns.
+ * Calling this API is necessary to trigger InApp messages on the device.
+ *
+ * @throws service exceptions - Thrown when the underlying Pinpoint service returns an error.
+ * @throws validation: {@link InAppMessagingValidationErrorCode} - Thrown when the provided parameters or library
+ *  configuration is incorrect.
+ *
+ * @returns A promise that will resolve when the operation is complete.
+ *
+ * @example
+ * ```ts
+ * // Sync InApp messages with Pinpoint and device.
+ * await syncMessages();
+ *
+ * ```
+ */
+export async function syncMessages(): Promise<void> {
+	const messages = await fetchInAppMessages();
+	if (messages.length === 0) {
+		return;
+	}
+	try {
+		const key = `${PINPOINT_KEY_PREFIX}${STORAGE_KEY_SUFFIX}`;
+		await defaultStorage.setItem(key, JSON.stringify(messages));
+	} catch (error) {
+		assertServiceError(error);
+		throw error;
+	}
+}
+
+async function fetchInAppMessages() {
+	try {
+		const { credentials, identityId } = await resolveCredentials();
+		const { appId, region } = resolveConfig();
+		let endpointId = await getEndpointId(appId, CATEGORY);
+
+		// Prepare a Pinpoint endpoint via updateEndpoint if one does not already exist, which will generate and cache an
+		// endpoint ID between calls
+		if (!endpointId) {
+			await updateEndpoint({
+				appId,
+				category: CATEGORY,
+				channelType: CHANNEL_TYPE,
+				credentials,
+				identityId,
+				region,
+				// TODO(V6): Update InAppMessagingAction.None
+				userAgentValue: getInAppMessagingUserAgentString(
+					InAppMessagingAction.None
+				),
+			});
+
+			endpointId = await getEndpointId(appId, CATEGORY);
+		}
+
+		assertValidationError(
+			!!endpointId,
+			InAppMessagingValidationErrorCode.NoEndpointId
+		);
+
+		const input: GetInAppMessagesInput = {
+			ApplicationId: appId,
+			EndpointId: endpointId,
+		};
+		const response: GetInAppMessagesOutput = await getInAppMessages(
+			{ credentials, region },
+			input
+		);
+		const { InAppMessageCampaigns: messages } = response.InAppMessagesResponse;
+		return messages;
+	} catch (error) {
+		assertServiceError(error);
+		throw error;
+	}
+}

package/src/{PushNotification/Providers → inAppMessaging/providers/pinpoint}/index.ts

@@ -1,4 +1,4 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-export { default as AWSPinpointProvider } from './AWSPinpointProvider';
+export { identifyUser, syncMessages } from './apis';

package/src/inAppMessaging/providers/pinpoint/utils/constants.ts

@@ -0,0 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export const PINPOINT_KEY_PREFIX = 'Pinpoint';
+export const STORAGE_KEY_SUFFIX = '_inAppMessages';
+export const CATEGORY = 'InAppMessaging';
+export const CHANNEL_TYPE = 'IN_APP';

package/src/inAppMessaging/providers/pinpoint/utils/index.ts

@@ -0,0 +1,12 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { resolveConfig } from './resolveConfig';
+export { resolveCredentials } from './resolveCredentials';
+export { getInAppMessagingUserAgentString } from './userAgent';
+export {
+	PINPOINT_KEY_PREFIX,
+	CATEGORY,
+	CHANNEL_TYPE,
+	STORAGE_KEY_SUFFIX,
+} from './constants';

package/src/inAppMessaging/providers/pinpoint/utils/resolveConfig.ts

@@ -0,0 +1,19 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { Amplify } from '@aws-amplify/core';
+import {
+	InAppMessagingValidationErrorCode,
+	assertValidationError,
+} from '../../../errors';
+
+/**
+ * @internal
+ */
+export const resolveConfig = () => {
+	const { appId, region } =
+		Amplify.getConfig().Notifications?.InAppMessaging.Pinpoint ?? {};
+	assertValidationError(!!appId, InAppMessagingValidationErrorCode.NoAppId);
+	assertValidationError(!!region, InAppMessagingValidationErrorCode.NoRegion);
+	return { appId, region };
+};

package/src/inAppMessaging/providers/pinpoint/utils/resolveCredentials.ts

@@ -0,0 +1,20 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { fetchAuthSession } from '@aws-amplify/core';
+import {
+	InAppMessagingValidationErrorCode,
+	assertValidationError,
+} from '../../../errors';
+
+/**
+ * @internal
+ */
+export const resolveCredentials = async () => {
+	const { credentials, identityId } = await fetchAuthSession();
+	assertValidationError(
+		!!credentials,
+		InAppMessagingValidationErrorCode.NoCredentials
+	);
+	return { credentials, identityId };
+};

package/src/inAppMessaging/providers/pinpoint/utils/userAgent.ts

@@ -0,0 +1,25 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import {
+	Category,
+	getAmplifyUserAgentObject,
+	getAmplifyUserAgent,
+	InAppMessagingAction,
+} from '@aws-amplify/core/internals/utils';
+import { UserAgent } from '@aws-sdk/types';
+
+export function getInAppMessagingUserAgent(
+	action: InAppMessagingAction
+): UserAgent {
+	return getAmplifyUserAgentObject({
+		category: Category.InAppMessaging,
+		action,
+	});
+}
+
+export function getInAppMessagingUserAgentString(action: InAppMessagingAction) {
+	return getAmplifyUserAgent({
+		category: Category.InAppMessaging,
+		action,
+	});
+}