@aws-amplify/notifications 1.6.6-unstable.7762f1a.0 → 2.0.0

package/package.json

@@ -1,38 +1,74 @@
 {
 	"name": "@aws-amplify/notifications",
-	"version": "1.6.6-unstable.7762f1a.0+7762f1a",
+	"version": "2.0.0",
 	"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"
-	],
+	"sideEffects": false,
 	"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": "npm run lint && jest -w 1 --coverage",
 		"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:cjs": "rimraf lib && tsc -m commonjs --outDir lib && webpack && webpack --config ./webpack.config.dev.js",
+		"build:esm": "rimraf lib-esm && tsc -m esnext --outDir lib-esm",
+		"build:cjs:watch": "rimraf lib && tsc -m commonjs --outDir lib --watch",
+		"build:esm:watch": "rimraf lib-esm && tsc -m esnext --outDir lib-esm --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"
+		"ts-coverage": "typescript-coverage-report -p ./tsconfig.json -t 88.21"
+	},
+	"typesVersions": {
+		">=4.2": {
+			"in-app-messaging": [
+				"./lib-esm/inAppMessaging/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"
+			]
+		}
 	},
-	"react-native": {
-		"./lib/index": "./lib-esm/index.js"
+	"exports": {
+		".": {
+			"types": "./lib-esm/index.d.ts",
+			"import": "./lib-esm/index.js",
+			"require": "./lib/index.js"
+		},
+		"./in-app-messaging": {
+			"types": "./lib-esm/inAppMessaging/index.d.ts",
+			"import": "./lib-esm/inAppMessaging/index.js",
+			"require": "./lib/inAppMessaging/index.js"
+		},
+		"./push-notifications": {
+			"types": "./lib-esm/pushNotifications/index.d.ts",
+			"import": "./lib-esm/pushNotifications/index.js",
+			"require": "./lib/pushNotifications/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-esm/index.js",
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/aws-amplify/amplify-js.git"
@@ -46,33 +82,63 @@
 	"files": [
 		"lib",
 		"lib-esm",
-		"src"
+		"src",
+		"in-app-messaging",
+		"push-notifications"
 	],
 	"dependencies": {
-		"@aws-amplify/cache": "5.1.12-unstable.7762f1a.0+7762f1a",
-		"@aws-amplify/core": "5.8.6-unstable.7762f1a.0+7762f1a",
-		"@aws-amplify/rtn-push-notification": "1.1.8-unstable.7762f1a.0+7762f1a",
 		"lodash": "^4.17.21",
-		"uuid": "^3.2.1"
+		"tslib": "^2.5.0"
+	},
+	"peerDependencies": {
+		"@aws-amplify/core": "^6.0.0"
 	},
 	"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"
+		"@aws-amplify/core": "6.0.0",
+		"@aws-amplify/react-native": "^1.0.0",
+		"typescript": "5.0.2"
 	},
-	"size-limit": [
-		{
-			"name": "Notifications (top-level class)",
-			"path": "./lib-esm/index.js",
-			"import": "{ Amplify, Notifications }",
-			"limit": "29.95 kB"
+	"jest": {
+		"globals": {
+			"__DEV__": true,
+			"ts-jest": {
+				"diagnostics": false,
+				"tsConfig": {
+					"allowJs": true,
+					"noEmitOnError": false
+				}
+			}
 		},
-		{
-			"name": "Notifications (with Analytics)",
-			"path": "./lib-esm/index.js",
-			"import": "{ Amplify, Notifications, Analytics }",
-			"limit": "29.95 kB"
-		}
-	],
-	"gitHead": "7762f1a7076e622ec354c24539a3b57ce3ec4290"
+		"transform": {
+			"^.+\\.(js|jsx|ts|tsx)$": "ts-jest"
+		},
+		"testPathIgnorePatterns": [
+			"/testUtils/"
+		],
+		"testRegex": "(/__tests__/.*|\\.(test|spec))\\.(tsx?|jsx?)$",
+		"moduleFileExtensions": [
+			"ts",
+			"tsx",
+			"js",
+			"json",
+			"jsx"
+		],
+		"testEnvironment": "jsdom",
+		"testURL": "http://localhost/",
+		"coverageThreshold": {
+			"global": {
+				"branches": 0,
+				"functions": 0,
+				"lines": 0,
+				"statements": 0
+			}
+		},
+		"coveragePathIgnorePatterns": [
+			"node_modules",
+			"dist",
+			"lib",
+			"lib-esm"
+		]
+	},
+	"gitHead": "d505105326d7f6214f6bd1e06eb20be3a3651377"
 }

package/push-notifications/package.json

@@ -0,0 +1,7 @@
+{
+	"name": "@aws-amplify/notifications/push-notifications",
+	"main": "../lib/pushNotifications/index.js",
+	"browser": "../lib-esm/pushNotifications/index.js",
+	"module": "../lib-esm/pushNotifications/index.js",
+	"typings": "../lib-esm/pushNotifications/index.d.ts"
+}

package/push-notifications/pinpoint/package.json

@@ -0,0 +1,7 @@
+{
+	"name": "@aws-amplify/notifications/push-notifications/pinpoint",
+	"main": "../../lib/pushNotifications/providers/pinpoint/index.js",
+	"browser": "../../lib-esm/pushNotifications/providers/pinpoint/index.js",
+	"module": "../../lib-esm/pushNotifications/providers/pinpoint/index.js",
+	"typings": "../../lib-esm/pushNotifications/providers/pinpoint/index.d.ts"
+}

package/src/{common/eventListeners/index.ts → eventListeners/eventListeners.ts}

@@ -1,7 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { EventListener, EventType } from './types';
+import { EventListener, EventListenerRemover, EventType } from './types';
 
 const eventListeners: Record<string, Set<EventListener<Function>>> = {};
 
@@ -28,7 +28,7 @@ export const notifyEventListenersAndAwaitHandlers = (
 export const addEventListener = <EventHandler extends Function>(
 	type: EventType,
 	handler: EventHandler
-): EventListener<EventHandler> => {
+): EventListenerRemover => {
 	// If there is no listener set for the event type, just create it
 	if (!eventListeners[type]) {
 		eventListeners[type] = new Set<EventListener<EventHandler>>();
@@ -40,5 +40,7 @@ export const addEventListener = <EventHandler extends Function>(
 		},
 	};
 	eventListeners[type].add(listener);
-	return listener;
+	return {
+		remove: () => listener.remove(),
+	};
 };

package/src/{common → eventListeners}/index.ts

@@ -1,11 +1,9 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-export { default as AWSPinpointProviderCommon } from './AWSPinpointProviderCommon';
-export { AMPLIFY_SYMBOL } from './constants';
 export {
 	addEventListener,
 	notifyEventListeners,
 	notifyEventListenersAndAwaitHandlers,
 } from './eventListeners';
-export { EventListener, EventType } from './eventListeners/types';
+export { EventListener, EventType, EventListenerRemover } from './types';

package/src/{common/eventListeners → 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;
@@ -10,3 +10,7 @@ export interface EventListener<EventHandler extends Function> {
 }
 
 export type EventType = InAppMessageInteractionEvent | PushNotificationEvent;
+
+export type EventListenerRemover = {
+	remove: () => void;
+};

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,29 @@
+// 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',
+	NotInitialized = 'NotInitialized',
+}
+
+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.NotInitialized]: {
+			message: 'In-app messaging has not been initialized.',
+			recoverySuggestion:
+				'Please make sure to first call `initializePushNotifications`.',
+		},
+	};

package/src/inAppMessaging/index.ts

@@ -0,0 +1,39 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export {
+	identifyUser,
+	syncMessages,
+	dispatchEvent,
+	setConflictHandler,
+	initializeInAppMessaging,
+	onMessageReceived,
+	onMessageDisplayed,
+	onMessageDismissed,
+	onMessageActionTaken,
+	notifyMessageInteraction,
+	clearMessages,
+	IdentifyUserInput,
+	DispatchEventInput,
+	SetConflictHandlerInput,
+	OnMessageActionTakenInput,
+	OnMessageDismissedInput,
+	OnMessageDisplayedInput,
+	OnMessageReceivedInput,
+	NotifyMessageInteractionInput,
+	OnMessageReceivedOutput,
+	OnMessageActionTakenOutput,
+	OnMessageDismissedOutput,
+	OnMessageDisplayedOutput,
+} from './providers/pinpoint';
+
+export {
+	InAppMessage,
+	InAppMessageAction,
+	InAppMessageContent,
+	InAppMessageLayout,
+	InAppMessageTextAlign,
+	InAppMessageButton,
+	InAppMessageImage,
+	InAppMessageStyle,
+} from './types';

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

@@ -0,0 +1,26 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { defaultStorage } from '@aws-amplify/core';
+import { STORAGE_KEY_SUFFIX, PINPOINT_KEY_PREFIX } from '../utils';
+
+import { InAppMessagingValidationErrorCode } from '../../../errors';
+import { assertIsInitialized } from '../../../utils';
+
+/**
+ * Clear locally cached messages.
+ *
+ * @throws validation: {@link InAppMessagingValidationErrorCode} - Thrown if In App messaging hasn't been initialized.
+ * @returns A promise that will resolve when the operation is complete.
+ * @example
+ * ```ts
+ * // Clear locally cached messages.
+ * await clearMessages();
+ *
+ * ```
+ */
+export async function clearMessages(): Promise<void> {
+	assertIsInitialized();
+	const key = `${PINPOINT_KEY_PREFIX}${STORAGE_KEY_SUFFIX}`;
+	return await defaultStorage.removeItem(key);
+}

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

@@ -0,0 +1,63 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	PINPOINT_KEY_PREFIX,
+	STORAGE_KEY_SUFFIX,
+	processInAppMessages,
+} from '../utils';
+import { InAppMessage } from '../../../types';
+import flatten from 'lodash/flatten';
+import { defaultStorage } from '@aws-amplify/core';
+import { notifyEventListeners } from '../../../../eventListeners';
+import { assertServiceError } from '../../../errors';
+import { DispatchEventInput } from '../types';
+import { syncMessages } from './syncMessages';
+import { conflictHandler, setConflictHandler } from './setConflictHandler';
+import { assertIsInitialized } from '../../../utils';
+
+/**
+ * Triggers an In-App message to be displayed. Use this after your campaigns have been synced to the device using
+ * {@link syncMessages}. Based on the messages synced and the event passed to this API, it triggers the display
+ * of the In-App message that meets the criteria.
+ *
+ * @remark
+ * If an event would trigger multiple messages, the message closest to expiry will be chosen by default.
+ * To change this behavior, you can use the {@link setConflictHandler} API to provide
+ * your own logic for resolving message conflicts.
+ *
+ * @param DispatchEventInput The input object that holds the event to be dispatched.
+ * @throws validation: {@link InAppMessagingValidationErrorCode} - Thrown when the provided parameters or library
+ * configuration is incorrect, or if In App messaging hasn't been initialized.
+ * @throws service exceptions - Thrown when the underlying Pinpoint service returns an error.
+ * @returns A promise that will resolve when the operation is complete.
+ * @example
+ * ```ts
+ * // Sync message before disptaching an event
+ * await syncMessages();
+ *
+ * // Dispatch an event
+ * await dispatchEvent({ name: 'test_event' });
+ * ```
+ */
+export async function dispatchEvent(input: DispatchEventInput): Promise<void> {
+	assertIsInitialized();
+	try {
+		const key = `${PINPOINT_KEY_PREFIX}${STORAGE_KEY_SUFFIX}`;
+		const cachedMessages = await defaultStorage.getItem(key);
+		const messages: InAppMessage[] = await processInAppMessages(
+			cachedMessages ? JSON.parse(cachedMessages) : [],
+			input
+		);
+		const flattenedMessages = flatten(messages);
+		if (flattenedMessages.length > 0) {
+			notifyEventListeners(
+				'messageReceived',
+				conflictHandler(flattenedMessages)
+			);
+		}
+	} catch (error) {
+		assertServiceError(error);
+		throw error;
+	}
+}

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

@@ -0,0 +1,94 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { InAppMessagingAction } from '@aws-amplify/core/internals/utils';
+import {
+	updateEndpoint,
+	UpdateEndpointException,
+} from '@aws-amplify/core/internals/providers/pinpoint';
+import { InAppMessagingValidationErrorCode } from '../../../errors';
+import {
+	CATEGORY,
+	CHANNEL_TYPE,
+	getInAppMessagingUserAgentString,
+	resolveConfig,
+	resolveCredentials,
+} from '../utils';
+import { IdentifyUserInput } from '../types';
+import { assertIsInitialized } from '../../../utils';
+
+/**
+ * Sends information about a user to Pinpoint. Sending user information allows you to associate a user to their user
+ * profile and activities or actions in your application. Activity can be tracked across devices & platforms by using
+ * the same `userId`.
+ *
+ * @param {IdentifyUserParameters} params The input object used to construct requests sent to Pinpoint's UpdateEndpoint
+ *  API.
+ * @throws service: {@link UpdateEndpointException} - Thrown when the underlying Pinpoint service returns an error.
+ * @throws validation: {@link InAppMessagingValidationErrorCode} - Thrown when the provided parameters or library
+ * configuration is incorrect, or if In App messaging hasn't been initialized.
+ * @returns A promise that will resolve when the operation is complete.
+ * @example
+ * ```ts
+ * // Identify a user with Pinpoint
+ * await identifyUser({
+ *     userId,
+ *     userProfile: {
+ *         email: 'userEmail@example.com'
+ *         customProperties: {
+ *             phoneNumber: ['555-555-5555'],
+ *         },
+ *     }
+ * });
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Identify a user with Pinpoint specific options
+ * await identifyUser({
+ *     userId,
+ *     userProfile: {
+ *         email: 'userEmail@example.com'
+ *         customProperties: {
+ *             phoneNumber: ['555-555-5555'],
+ *         },
+ *         demographic: {
+ *             platform: 'ios',
+ *             timezone: 'America/Los_Angeles'
+ *         }
+ *     },
+ *     options: {
+ *         address: 'device-address',
+ *         optOut: 'NONE',
+ *         userAttributes: {
+ *             interests: ['food']
+ *         },
+ *     },
+ * });
+ */
+export const identifyUser = async ({
+	userId,
+	userProfile,
+	options,
+}: IdentifyUserInput): Promise<void> => {
+	assertIsInitialized();
+	const { credentials, identityId } = await resolveCredentials();
+	const { appId, region } = resolveConfig();
+	const { address, optOut, userAttributes } = options ?? {};
+	updateEndpoint({
+		address,
+		channelType: CHANNEL_TYPE,
+		optOut,
+		appId,
+		category: CATEGORY,
+		credentials,
+		identityId,
+		region,
+		userAttributes,
+		userId,
+		userProfile,
+		userAgentValue: getInAppMessagingUserAgentString(
+			InAppMessagingAction.IdentifyUser
+		),
+	});
+};

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

@@ -0,0 +1,14 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { identifyUser } from './identifyUser';
+export { syncMessages } from './syncMessages';
+export { dispatchEvent } from './dispatchEvent';
+export { setConflictHandler } from './setConflictHandler';
+export { initializeInAppMessaging } from './initializeInAppMessaging';
+export { onMessageReceived } from './onMessageReceived';
+export { onMessageDismissed } from './onMessageDismissed';
+export { onMessageDisplayed } from './onMessageDisplayed';
+export { onMessageActionTaken } from './onMessageActionTaken';
+export { notifyMessageInteraction } from './notifyMessageInteraction';
+export { clearMessages } from './clearMessages';

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

@@ -0,0 +1,62 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { sessionListener } from '@aws-amplify/core/internals/utils';
+import { InAppMessage, InAppMessagingEvent } from '../../../types';
+import { addEventListener } from '../../../../eventListeners';
+import { recordAnalyticsEvent } from '../utils/helpers';
+import { PinpointMessageEvent } from '../types';
+import { Hub, HubCapsule } from '@aws-amplify/core';
+import { dispatchEvent } from './dispatchEvent';
+import { incrementMessageCounts, sessionStateChangeHandler } from '../utils';
+import { isInitialized, initialize } from '../../../utils';
+
+/**
+ * Initialize and set up in-app messaging category. This API needs to be called to enable other InAppMessaging APIs.
+ *
+ * @remarks
+ * Make sure to call this early in your app at the root entry point after configuring Amplify.
+ * @example
+ * ```ts
+ * Amplify.configure(config);
+ * initializeInAppMessaging();
+ * ```
+ */
+export function initializeInAppMessaging(): void {
+	if (isInitialized()) {
+		return;
+	}
+	// register with the session listener
+	sessionListener.addStateChangeListener(sessionStateChangeHandler, true);
+
+	// wire up default Pinpoint message event handling
+	addEventListener('messageDisplayed', (message: InAppMessage) => {
+		recordAnalyticsEvent(PinpointMessageEvent.MESSAGE_DISPLAYED, message);
+		incrementMessageCounts(message.id);
+	});
+	addEventListener('messageDismissed', (message: InAppMessage) => {
+		recordAnalyticsEvent(PinpointMessageEvent.MESSAGE_DISMISSED, message);
+	});
+	addEventListener('messageActionTaken', (message: InAppMessage) => {
+		recordAnalyticsEvent(PinpointMessageEvent.MESSAGE_ACTION_TAKEN, message);
+	});
+
+	// listen to analytics hub events
+	Hub.listen('analytics', analyticsListener);
+
+	initialize();
+}
+
+function analyticsListener({
+	payload,
+}: HubCapsule<string, { event: string; data: InAppMessagingEvent }>) {
+	const { event, data } = payload;
+	switch (event) {
+		case 'record': {
+			dispatchEvent(data);
+			break;
+		}
+		default:
+			break;
+	}
+}