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

package/src/{InAppMessaging/Providers/AWSPinpointProvider/utils.ts → inAppMessaging/providers/pinpoint/utils/helpers.ts}

@@ -1,10 +1,10 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { Amplify, ConsoleLogger, Hub } from '@aws-amplify/core';
+import { ConsoleLogger } from '@aws-amplify/core';
+import { InAppMessagingAction } from '@aws-amplify/core/internals/utils';
 import type { InAppMessageCampaign as PinpointInAppMessage } from '@aws-amplify/core/internals/aws-clients/pinpoint';
 import isEmpty from 'lodash/isEmpty';
-import { AMPLIFY_SYMBOL } from '../../../common';
 import {
 	InAppMessage,
 	InAppMessageAction,
@@ -12,48 +12,55 @@ import {
 	InAppMessageLayout,
 	InAppMessageTextAlign,
 	InAppMessagingEvent,
-} from '../../types';
-
-import { AWSPinpointMessageEvent, MetricsComparator } from './types';
+} from '../../../types';
+import { MetricsComparator, PinpointMessageEvent } from '../types';
+import { record as recordCore } from '@aws-amplify/core/internals/providers/pinpoint';
+import { resolveConfig } from './resolveConfig';
+import { resolveCredentials } from './resolveCredentials';
+import { CATEGORY } from './constants';
+import { getInAppMessagingUserAgentString } from './userAgent';
 
 const DELIVERY_TYPE = 'IN_APP_MESSAGE';
 
-let eventNameMemo = {};
-let eventAttributesMemo = {};
-let eventMetricsMemo = {};
-
-export const logger = new ConsoleLogger('InAppMessaging.AWSPinpointProvider');
+let eventNameMemo: Record<string, boolean> = {};
+let eventAttributesMemo: Record<string, boolean> = {};
+let eventMetricsMemo: Record<string, boolean> = {};
 
-export const dispatchInAppMessagingEvent = (
-	event: string,
-	data: any,
-	message?: string
-) => {
-	Hub.dispatch(
-		'inAppMessaging',
-		{ event, data, message },
-		'InAppMessaging',
-		AMPLIFY_SYMBOL
-	);
-};
+export const logger = new ConsoleLogger('InAppMessaging.Pinpoint.Utils');
 
 export const recordAnalyticsEvent = (
-	event: AWSPinpointMessageEvent,
+	event: PinpointMessageEvent,
 	message: InAppMessage
 ) => {
-	if (Amplify.Analytics && typeof Amplify.Analytics.record === 'function') {
-		const { id, metadata } = message;
-		Amplify.Analytics.record({
-			name: event,
-			attributes: {
-				campaign_id: id,
-				delivery_type: DELIVERY_TYPE,
-				treatment_id: metadata?.treatmentId,
-			},
+	const { appId, region } = resolveConfig();
+
+	const { id, metadata } = message;
+	resolveCredentials()
+		.then(({ credentials, identityId }) => {
+			recordCore({
+				appId,
+				category: CATEGORY,
+				credentials,
+				event: {
+					name: event,
+					attributes: {
+						// only include campaign_id field if we have one
+						...(id && { campaign_id: id }),
+						delivery_type: DELIVERY_TYPE,
+						treatment_id: metadata?.treatmentId,
+					},
+				},
+				identityId,
+				region,
+				userAgentValue: getInAppMessagingUserAgentString(
+					InAppMessagingAction.NotifyMessageInteraction
+				),
+			});
+		})
+		.catch(e => {
+			// An error occured while fetching credentials or persisting the event to the buffer
+			logger.warn('Failed to record event.', e);
 		});
-	} else {
-		logger.debug('Analytics module is not registered into Amplify');
-	}
 };
 
 export const getStartOfDay = (): string => {
@@ -66,19 +73,19 @@ export const matchesEventType = (
 	{ CampaignId, Schedule }: PinpointInAppMessage,
 	{ name: eventType }: InAppMessagingEvent
 ) => {
-	const { EventType } = Schedule?.EventFilter?.Dimensions;
+	const { EventType } = Schedule?.EventFilter?.Dimensions ?? {};
 	const memoKey = `${CampaignId}:${eventType}`;
 	if (!eventNameMemo.hasOwnProperty(memoKey)) {
-		eventNameMemo[memoKey] = !!EventType?.Values.includes(eventType);
+		eventNameMemo[memoKey] = !!EventType?.Values?.includes(eventType);
 	}
 	return eventNameMemo[memoKey];
 };
 
 export const matchesAttributes = (
 	{ CampaignId, Schedule }: PinpointInAppMessage,
-	{ attributes }: InAppMessagingEvent
+	{ attributes = {} }: InAppMessagingEvent
 ): boolean => {
-	const { Attributes } = Schedule?.EventFilter?.Dimensions;
+	const { Attributes } = Schedule?.EventFilter?.Dimensions ?? {};
 	if (isEmpty(Attributes)) {
 		// if message does not have attributes defined it does not matter what attributes are on the event
 		return true;
@@ -89,18 +96,20 @@ export const matchesAttributes = (
 	}
 	const memoKey = `${CampaignId}:${JSON.stringify(attributes)}`;
 	if (!eventAttributesMemo.hasOwnProperty(memoKey)) {
-		eventAttributesMemo[memoKey] = Object.entries(Attributes).every(
-			([key, { Values }]) => Values.includes(attributes[key])
-		);
+		eventAttributesMemo[memoKey] =
+			!Attributes ||
+			Object.entries(Attributes).every(([key, { Values }]) =>
+				Values?.includes(attributes[key])
+			);
 	}
 	return eventAttributesMemo[memoKey];
 };
 
 export const matchesMetrics = (
 	{ CampaignId, Schedule }: PinpointInAppMessage,
-	{ metrics }: InAppMessagingEvent
+	{ metrics = {} }: InAppMessagingEvent
 ): boolean => {
-	const { Metrics } = Schedule?.EventFilter?.Dimensions;
+	const { Metrics } = Schedule?.EventFilter?.Dimensions ?? {};
 	if (isEmpty(Metrics)) {
 		// if message does not have metrics defined it does not matter what metrics are on the event
 		return true;
@@ -111,18 +120,20 @@ export const matchesMetrics = (
 	}
 	const memoKey = `${CampaignId}:${JSON.stringify(metrics)}`;
 	if (!eventMetricsMemo.hasOwnProperty(memoKey)) {
-		eventMetricsMemo[memoKey] = Object.entries(Metrics).every(
-			([key, { ComparisonOperator, Value }]) => {
+		eventMetricsMemo[memoKey] =
+			!Metrics ||
+			Object.entries(Metrics).every(([key, { ComparisonOperator, Value }]) => {
 				const compare = getComparator(ComparisonOperator);
 				// if there is some unknown comparison operator, treat as a comparison failure
-				return compare ? compare(Value, metrics[key]) : false;
-			}
-		);
+				return compare && !!Value ? compare(Value, metrics[key]) : false;
+			});
 	}
 	return eventMetricsMemo[memoKey];
 };
 
-export const getComparator = (operator: string): MetricsComparator => {
+export const getComparator = (
+	operator?: string
+): MetricsComparator | undefined => {
 	switch (operator) {
 		case 'EQUAL':
 			return (metricsVal, eventVal) => metricsVal === eventVal;
@@ -135,7 +146,7 @@ export const getComparator = (operator: string): MetricsComparator => {
 		case 'LESS_THAN_OR_EQUAL':
 			return (metricsVal, eventVal) => metricsVal >= eventVal;
 		default:
-			return null;
+			return undefined;
 	}
 };
 
@@ -212,8 +223,9 @@ export const clearMemo = () => {
 // - 1. the usage of MOBILE_FEED and OVERLAYS as values for message layouts are not leaked
 //      outside the Pinpoint provider
 // - 2. Amplify correctly handles the legacy layout values from Pinpoint after they are updated
+
 export const interpretLayout = (
-	layout: PinpointInAppMessage['InAppMessage']['Layout']
+	layout: NonNullable<PinpointInAppMessage['InAppMessage']>['Layout']
 ): InAppMessageLayout => {
 	if (layout === 'MOBILE_FEED') {
 		return 'MODAL';
@@ -252,21 +264,23 @@ export const extractContent = ({
 			}
 			if (HeaderConfig) {
 				extractedContent.header = {
-					content: HeaderConfig.Header,
+					// Default to empty string in rare cases we don't have a Header value
+					content: HeaderConfig.Header ?? '',
 					style: {
 						color: HeaderConfig.TextColor,
 						textAlign:
-							HeaderConfig.Alignment.toLowerCase() as InAppMessageTextAlign,
+							HeaderConfig.Alignment?.toLowerCase() as InAppMessageTextAlign,
 					},
 				};
 			}
 			if (BodyConfig) {
 				extractedContent.body = {
-					content: BodyConfig.Body,
+					// Default to empty string in rare cases we don't have a Body value
+					content: BodyConfig.Body ?? '',
 					style: {
 						color: BodyConfig.TextColor,
 						textAlign:
-							BodyConfig.Alignment.toLowerCase() as InAppMessageTextAlign,
+							BodyConfig.Alignment?.toLowerCase() as InAppMessageTextAlign,
 					},
 				};
 			}
@@ -277,7 +291,8 @@ export const extractContent = ({
 			}
 			if (defaultPrimaryButton) {
 				extractedContent.primaryButton = {
-					title: defaultPrimaryButton.Text,
+					// Default to empty string in rare cases we don't have a Text value
+					title: defaultPrimaryButton.Text ?? '',
 					action: defaultPrimaryButton.ButtonAction as InAppMessageAction,
 					url: defaultPrimaryButton.Link,
 					style: {
@@ -289,7 +304,8 @@ export const extractContent = ({
 			}
 			if (defaultSecondaryButton) {
 				extractedContent.secondaryButton = {
-					title: defaultSecondaryButton.Text,
+					// Default to empty string in rare cases we don't have a Text value
+					title: defaultSecondaryButton.Text ?? '',
 					action: defaultSecondaryButton.ButtonAction as InAppMessageAction,
 					url: defaultSecondaryButton.Link,
 					style: {

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

@@ -0,0 +1,18 @@
+// 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';
+
+export {
+	processInAppMessages,
+	sessionStateChangeHandler,
+	incrementMessageCounts,
+} from './messageProcessingHelpers';

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

@@ -0,0 +1,210 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { InAppMessage, InAppMessagingEvent } from '../../../types';
+import {
+	InAppMessageCounts,
+	InAppMessageCountMap,
+	DailyInAppMessageCounter,
+} from '../types';
+import {
+	extractContent,
+	extractMetadata,
+	interpretLayout,
+	isBeforeEndDate,
+	matchesAttributes,
+	matchesEventType,
+	matchesMetrics,
+} from './helpers';
+import type { InAppMessageCampaign as PinpointInAppMessage } from '@aws-amplify/core/internals/aws-clients/pinpoint';
+import { defaultStorage, ConsoleLogger } from '@aws-amplify/core';
+import { SessionState } from '@aws-amplify/core/internals/utils';
+
+const MESSAGE_DAILY_COUNT_KEY = 'pinpointProvider_inAppMessages_dailyCount';
+const MESSAGE_TOTAL_COUNT_KEY = 'pinpointProvider_inAppMessages_totalCount';
+const logger = new ConsoleLogger('InAppMessaging.processInAppMessages');
+
+let sessionMessageCountMap: InAppMessageCountMap = {};
+
+export async function processInAppMessages(
+	messages: PinpointInAppMessage[],
+	event: InAppMessagingEvent
+): Promise<InAppMessage[]> {
+	let highestPrioritySeen: number | undefined;
+	let acc: PinpointInAppMessage[] = [];
+	for (let index = 0; index < messages.length; index++) {
+		const message = messages[index];
+		const messageQualifies =
+			matchesEventType(message, event) &&
+			matchesAttributes(message, event) &&
+			matchesMetrics(message, event) &&
+			isBeforeEndDate(message) &&
+			(await isBelowCap(message));
+		// filter all qualifying messages returning only those that are of (relative) highest priority
+		if (messageQualifies) {
+			// have not yet encountered message with priority
+			if (!highestPrioritySeen) {
+				// this message has priority, so reset the accumulator with this message only
+				if (message.Priority) {
+					highestPrioritySeen = message.Priority;
+					acc = [message];
+				} else {
+					// this message also has no priority, so just add this message to accumulator
+					acc.push(message);
+				}
+				// have previously encountered message with priority, so only messages with priority matter now
+			} else if (message.Priority) {
+				// this message has higher priority (lower number), so reset the accumulator with this message only
+				if (message.Priority < highestPrioritySeen) {
+					highestPrioritySeen = message.Priority;
+					acc = [message];
+					// this message has the same priority, so just add this message to accumulator
+				} else if (message.Priority === highestPrioritySeen) {
+					acc.push(message);
+				}
+			}
+		}
+	}
+	return normalizeMessages(acc);
+}
+
+export function sessionStateChangeHandler(state: SessionState): void {
+	if (state === 'started') {
+		// reset all session counts
+		sessionMessageCountMap = {};
+	}
+}
+
+export async function incrementMessageCounts(messageId: string): Promise<void> {
+	const { sessionCount, dailyCount, totalCount } = await getMessageCounts(
+		messageId
+	);
+	setSessionCount(messageId, sessionCount + 1);
+	setDailyCount(dailyCount + 1);
+	await setTotalCount(messageId, totalCount + 1);
+}
+
+function normalizeMessages(messages: PinpointInAppMessage[]): InAppMessage[] {
+	return messages.map(message => {
+		const { CampaignId, InAppMessage } = message;
+		return {
+			// Default to empty string in rare cases we don't have a campaignId
+			id: CampaignId ?? '',
+			content: extractContent(message),
+			// Default to TOP_BANNER layout in rare cases we don't have a Layout
+			layout: InAppMessage?.Layout
+				? interpretLayout(InAppMessage.Layout)
+				: 'TOP_BANNER',
+			metadata: extractMetadata(message),
+		};
+	});
+}
+
+async function isBelowCap({
+	CampaignId,
+	SessionCap,
+	DailyCap,
+	TotalCap,
+}: PinpointInAppMessage): Promise<Boolean> {
+	const { sessionCount, dailyCount, totalCount } = await getMessageCounts(
+		CampaignId
+	);
+
+	return (
+		(!SessionCap || sessionCount < SessionCap) &&
+		(!DailyCap || dailyCount < DailyCap) &&
+		(!TotalCap || totalCount < TotalCap)
+	);
+}
+
+async function getMessageCounts(
+	messageId?: string
+): Promise<InAppMessageCounts> {
+	let messageCounts = {
+		sessionCount: 0,
+		dailyCount: 0,
+		totalCount: 0,
+	};
+	try {
+		// only return true counts if there is a messageId else default to 0
+		if (messageId)
+			messageCounts = {
+				sessionCount: getSessionCount(messageId),
+				dailyCount: await getDailyCount(),
+				totalCount: await getTotalCount(messageId),
+			};
+		return messageCounts;
+	} catch (err) {
+		logger.error('Failed to get message counts from storage', err);
+
+		// If there are no cached counts or there is an error,
+		// we default to 0 allowing all the messages to be eligible
+		return messageCounts;
+	}
+}
+
+function getSessionCount(messageId: string): number {
+	return sessionMessageCountMap[messageId] ?? 0;
+}
+
+function setSessionCount(messageId: string, count: number): void {
+	sessionMessageCountMap[messageId] = count;
+}
+
+function setDailyCount(count: number): void {
+	const dailyCount: DailyInAppMessageCounter = {
+		count,
+		lastCountTimestamp: getStartOfDay(),
+	};
+	try {
+		defaultStorage.setItem(MESSAGE_DAILY_COUNT_KEY, JSON.stringify(dailyCount));
+	} catch (err) {
+		logger.error('Failed to save daily message count to storage', err);
+	}
+}
+
+function setTotalCountMap(countMap: InAppMessageCountMap): void {
+	try {
+		defaultStorage.setItem(MESSAGE_TOTAL_COUNT_KEY, JSON.stringify(countMap));
+	} catch (err) {
+		logger.error('Failed to save total count to storage', err);
+	}
+}
+
+async function setTotalCount(messageId: string, count: number): Promise<void> {
+	const totalCountMap = await getTotalCountMap();
+	const updatedMap = {
+		...totalCountMap,
+		[messageId]: count,
+	};
+	setTotalCountMap(updatedMap);
+}
+
+async function getDailyCount(): Promise<number> {
+	const today = getStartOfDay();
+	const item = await defaultStorage.getItem(MESSAGE_DAILY_COUNT_KEY);
+	// Parse stored count or initialize as empty count
+	const counter: DailyInAppMessageCounter = item
+		? JSON.parse(item)
+		: { count: 0, lastCountTimestamp: today };
+	// If the stored counter timestamp is today, use it as the count, otherwise reset to 0
+	return counter.lastCountTimestamp === today ? counter.count : 0;
+}
+
+async function getTotalCountMap(): Promise<InAppMessageCountMap> {
+	const item = await defaultStorage.getItem(MESSAGE_TOTAL_COUNT_KEY);
+	// Parse stored count map or initialize as empty
+	return item ? JSON.parse(item) : {};
+}
+
+async function getTotalCount(messageId: string): Promise<number> {
+	const countMap = await getTotalCountMap();
+	// Return stored count or initialize as empty count
+	return countMap[messageId] || 0;
+}
+
+const getStartOfDay = (): string => {
+	const now = new Date();
+	now.setHours(0, 0, 0, 0);
+	return now.toISOString();
+};

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

package/src/inAppMessaging/types/event.ts

@@ -0,0 +1,14 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export type InAppMessageInteractionEvent =
+	| 'messageReceived'
+	| 'messageDisplayed'
+	| 'messageDismissed'
+	| 'messageActionTaken';
+
+export type InAppMessagingEvent = {
+	name: string;
+	attributes?: Record<string, string>;
+	metrics?: Record<string, number>;
+};

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

@@ -1,17 +1,16 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-export { default } from './InAppMessaging';
+export { InAppMessagingServiceOptions } from './options';
+export { InAppMessagingIdentifyUserInput } from './inputs';
+export { InAppMessageInteractionEvent, InAppMessagingEvent } from './event';
 export {
 	InAppMessage,
 	InAppMessageAction,
-	InAppMessageButton,
 	InAppMessageContent,
-	InAppMessageImage,
-	InAppMessageInteractionEvent,
 	InAppMessageLayout,
-	InAppMessageStyle,
 	InAppMessageTextAlign,
-	InAppMessagingConfig,
-	InAppMessagingEvent,
-} from './types';
+	InAppMessageButton,
+	InAppMessageImage,
+	InAppMessageStyle,
+} from './message';

package/src/inAppMessaging/types/inputs.ts

@@ -0,0 +1,27 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { UserProfile } from '@aws-amplify/core';
+import { InAppMessagingServiceOptions } from '.';
+
+/**
+ * Input type for `identifyUser`.
+ */
+export type InAppMessagingIdentifyUserInput<
+	ServiceOptions extends InAppMessagingServiceOptions = InAppMessagingServiceOptions
+> = {
+	/**
+	 * A User ID associated to the current device.
+	 */
+	userId: string;
+
+	/**
+	 * Additional information about the user and their device.
+	 */
+	userProfile: UserProfile;
+
+	/**
+	 * Options to be passed to the API.
+	 */
+	options?: ServiceOptions;
+};

package/src/inAppMessaging/types/message.ts

@@ -0,0 +1,62 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export type InAppMessageLayout =
+	| 'BOTTOM_BANNER'
+	| 'CAROUSEL'
+	| 'FULL_SCREEN'
+	| 'MIDDLE_BANNER'
+	| 'MODAL'
+	| 'TOP_BANNER';
+
+export type InAppMessageAction = 'CLOSE' | 'DEEP_LINK' | 'LINK';
+
+export type InAppMessageTextAlign = 'center' | 'left' | 'right';
+
+interface InAppMessageContainer {
+	style?: InAppMessageStyle;
+}
+
+interface InAppMessageHeader {
+	content: string;
+	style?: InAppMessageStyle;
+}
+
+interface InAppMessageBody {
+	content: string;
+	style?: InAppMessageStyle;
+}
+
+export interface InAppMessageImage {
+	src: string;
+}
+
+export interface InAppMessageButton {
+	title: string;
+	action: InAppMessageAction;
+	url?: string;
+	style?: InAppMessageStyle;
+}
+
+export interface InAppMessageStyle {
+	backgroundColor?: string;
+	borderRadius?: number;
+	color?: string;
+	textAlign?: InAppMessageTextAlign;
+}
+
+export interface InAppMessageContent {
+	container?: InAppMessageContainer;
+	header?: InAppMessageHeader;
+	body?: InAppMessageBody;
+	image?: InAppMessageImage;
+	primaryButton?: InAppMessageButton;
+	secondaryButton?: InAppMessageButton;
+}
+
+export interface InAppMessage {
+	id: string;
+	layout: InAppMessageLayout;
+	content: InAppMessageContent[];
+	metadata?: any;
+}

package/src/inAppMessaging/types/options.ts

@@ -0,0 +1,7 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * Base type for service options.
+ */
+export type InAppMessagingServiceOptions = Record<string, unknown>;