@aws-amplify/notifications 1.6.6-api-v6-models.b3abc9b.0 → 2.0.0

package/lib-esm/inAppMessaging/providers/pinpoint/apis/clearMessages.js

@@ -0,0 +1,22 @@
+// 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 { 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() {
+    assertIsInitialized();
+    const key = `${PINPOINT_KEY_PREFIX}${STORAGE_KEY_SUFFIX}`;
+    return await defaultStorage.removeItem(key);
+}

package/lib-esm/inAppMessaging/providers/pinpoint/apis/dispatchEvent.d.ts

@@ -0,0 +1,26 @@
+import { DispatchEventInput } from '../types';
+/**
+ * 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 declare function dispatchEvent(input: DispatchEventInput): Promise<void>;

package/lib-esm/inAppMessaging/providers/pinpoint/apis/dispatchEvent.js

@@ -0,0 +1,49 @@
+// 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 flatten from 'lodash/flatten';
+import { defaultStorage } from '@aws-amplify/core';
+import { notifyEventListeners } from '../../../../eventListeners';
+import { assertServiceError } from '../../../errors';
+import { conflictHandler } 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) {
+    assertIsInitialized();
+    try {
+        const key = `${PINPOINT_KEY_PREFIX}${STORAGE_KEY_SUFFIX}`;
+        const cachedMessages = await defaultStorage.getItem(key);
+        const messages = 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/lib-esm/inAppMessaging/providers/pinpoint/apis/identifyUser.d.ts

@@ -0,0 +1,51 @@
+import { IdentifyUserInput } from '../types';
+/**
+ * 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 declare const identifyUser: ({ userId, userProfile, options, }: IdentifyUserInput) => Promise<void>;

package/lib-esm/inAppMessaging/providers/pinpoint/apis/identifyUser.js

@@ -0,0 +1,75 @@
+// 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, } from '@aws-amplify/core/internals/providers/pinpoint';
+import { CATEGORY, CHANNEL_TYPE, getInAppMessagingUserAgentString, resolveConfig, resolveCredentials, } from '../utils';
+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, }) => {
+    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/lib-esm/inAppMessaging/providers/pinpoint/apis/index.d.ts

@@ -0,0 +1,11 @@
+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/lib-esm/inAppMessaging/providers/pinpoint/apis/index.js

@@ -0,0 +1,13 @@
+// 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/lib-esm/inAppMessaging/providers/pinpoint/apis/initializeInAppMessaging.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 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 declare function initializeInAppMessaging(): void;

package/lib-esm/inAppMessaging/providers/pinpoint/apis/initializeInAppMessaging.js

@@ -0,0 +1,53 @@
+// 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 { addEventListener } from '../../../../eventListeners';
+import { recordAnalyticsEvent } from '../utils/helpers';
+import { PinpointMessageEvent } from '../types';
+import { Hub } 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() {
+    if (isInitialized()) {
+        return;
+    }
+    // register with the session listener
+    sessionListener.addStateChangeListener(sessionStateChangeHandler, true);
+    // wire up default Pinpoint message event handling
+    addEventListener('messageDisplayed', (message) => {
+        recordAnalyticsEvent(PinpointMessageEvent.MESSAGE_DISPLAYED, message);
+        incrementMessageCounts(message.id);
+    });
+    addEventListener('messageDismissed', (message) => {
+        recordAnalyticsEvent(PinpointMessageEvent.MESSAGE_DISMISSED, message);
+    });
+    addEventListener('messageActionTaken', (message) => {
+        recordAnalyticsEvent(PinpointMessageEvent.MESSAGE_ACTION_TAKEN, message);
+    });
+    // listen to analytics hub events
+    Hub.listen('analytics', analyticsListener);
+    initialize();
+}
+function analyticsListener({ payload, }) {
+    const { event, data } = payload;
+    switch (event) {
+        case 'record': {
+            dispatchEvent(data);
+            break;
+        }
+        default:
+            break;
+    }
+}

package/lib-esm/inAppMessaging/providers/pinpoint/apis/notifyMessageInteraction.d.ts

@@ -0,0 +1,16 @@
+import { NotifyMessageInteractionInput } from '../types/inputs';
+/**
+ * Notifies the respective listener of the specified type with the message given.
+ *
+ * @param {NotifyMessageInteractionInput} input - The input object that holds the type and message.
+ * @throws validation: {@link InAppMessagingValidationErrorCode} - Thrown when the provided parameters or library
+ * configuration is incorrect, or if In App messaging hasn't been initialized.
+ * @example
+ * ```ts
+ * onMessageRecieved((message) => {
+ *   // Show end users the In-App message and notify event listeners
+ *   notifyMessageInteraction({ type: 'messageDisplayed', message });
+ * });
+ * ```
+ */
+export declare function notifyMessageInteraction({ type, message, }: NotifyMessageInteractionInput): void;

package/lib-esm/inAppMessaging/providers/pinpoint/apis/notifyMessageInteraction.js

@@ -0,0 +1,22 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { notifyEventListeners } from '../../../../eventListeners';
+import { assertIsInitialized } from '../../../utils';
+/**
+ * Notifies the respective listener of the specified type with the message given.
+ *
+ * @param {NotifyMessageInteractionInput} input - The input object that holds the type and message.
+ * @throws validation: {@link InAppMessagingValidationErrorCode} - Thrown when the provided parameters or library
+ * configuration is incorrect, or if In App messaging hasn't been initialized.
+ * @example
+ * ```ts
+ * onMessageRecieved((message) => {
+ *   // Show end users the In-App message and notify event listeners
+ *   notifyMessageInteraction({ type: 'messageDisplayed', message });
+ * });
+ * ```
+ */
+export function notifyMessageInteraction({ type, message, }) {
+    assertIsInitialized();
+    notifyEventListeners(type, message);
+}

package/lib-esm/inAppMessaging/providers/pinpoint/apis/onMessageActionTaken.d.ts

@@ -0,0 +1,18 @@
+import { OnMessageActionTakenInput } from '../types/inputs';
+import { OnMessageActionTakenOutput } from '../types/outputs';
+/**
+ * Registers a callback that will be invoked on `messageActionTaken` events.
+ *
+ * @param {OnMessageActionTakenInput} input - The input object that holds the callback handler.
+ * @throws validation: {@link InAppMessagingValidationErrorCode} - Thrown when the provided parameters or library
+ * configuration is incorrect, or if In App messaging hasn't been initialized.
+ * @returns {OnMessageActionTakenOutput} - An object that holds a remove method to stop listening to events.
+ * @example
+ * ```ts
+ * onMessageActionTaken((message) => {
+ *   // use the message
+ *   console.log(message.id);
+ * });
+ * ```
+ */
+export declare function onMessageActionTaken(input: OnMessageActionTakenInput): OnMessageActionTakenOutput;

package/lib-esm/inAppMessaging/providers/pinpoint/apis/onMessageActionTaken.js

@@ -0,0 +1,23 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { addEventListener } from '../../../../eventListeners';
+import { assertIsInitialized } from '../../../utils';
+/**
+ * Registers a callback that will be invoked on `messageActionTaken` events.
+ *
+ * @param {OnMessageActionTakenInput} input - The input object that holds the callback handler.
+ * @throws validation: {@link InAppMessagingValidationErrorCode} - Thrown when the provided parameters or library
+ * configuration is incorrect, or if In App messaging hasn't been initialized.
+ * @returns {OnMessageActionTakenOutput} - An object that holds a remove method to stop listening to events.
+ * @example
+ * ```ts
+ * onMessageActionTaken((message) => {
+ *   // use the message
+ *   console.log(message.id);
+ * });
+ * ```
+ */
+export function onMessageActionTaken(input) {
+    assertIsInitialized();
+    return addEventListener('messageActionTaken', input);
+}

package/lib-esm/inAppMessaging/providers/pinpoint/apis/onMessageDismissed.d.ts

@@ -0,0 +1,18 @@
+import { OnMessageDismissedOutput } from '../types/outputs';
+import { OnMessageDismissedInput } from '../types/inputs';
+/**
+ * Registers a callback that will be invoked on `messageDismissed` events.
+ *
+ * @param {OnMessageDismissedInput} input - The input object that holds the callback handler.
+ * @throws validation: {@link InAppMessagingValidationErrorCode} - Thrown when the provided parameters or library
+ * configuration is incorrect, or if In App messaging hasn't been initialized.
+ * @returns {OnMessageDismissedOutput} - An object that holds a remove method to stop listening to events.
+ * @example
+ * ```ts
+ * onMessageDismissed((message) => {
+ *   // use the message
+ *   console.log(message.id);
+ * });
+ * ```
+ */
+export declare function onMessageDismissed(input: OnMessageDismissedInput): OnMessageDismissedOutput;

package/lib-esm/inAppMessaging/providers/pinpoint/apis/onMessageDismissed.js

@@ -0,0 +1,23 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { addEventListener } from '../../../../eventListeners';
+import { assertIsInitialized } from '../../../utils';
+/**
+ * Registers a callback that will be invoked on `messageDismissed` events.
+ *
+ * @param {OnMessageDismissedInput} input - The input object that holds the callback handler.
+ * @throws validation: {@link InAppMessagingValidationErrorCode} - Thrown when the provided parameters or library
+ * configuration is incorrect, or if In App messaging hasn't been initialized.
+ * @returns {OnMessageDismissedOutput} - An object that holds a remove method to stop listening to events.
+ * @example
+ * ```ts
+ * onMessageDismissed((message) => {
+ *   // use the message
+ *   console.log(message.id);
+ * });
+ * ```
+ */
+export function onMessageDismissed(input) {
+    assertIsInitialized();
+    return addEventListener('messageDismissed', input);
+}

package/lib-esm/inAppMessaging/providers/pinpoint/apis/onMessageDisplayed.d.ts

@@ -0,0 +1,18 @@
+import { OnMessageDisplayedOutput } from '../types/outputs';
+import { OnMessageDisplayedInput } from '../types/inputs';
+/**
+ * Registers a callback that will be invoked on `messageDisplayed` events.
+ *
+ * @param {OnMessageDisplayedInput} input - The input object that holds the callback handler.
+ * @throws validation: {@link InAppMessagingValidationErrorCode} - Thrown when the provided parameters or library
+ * configuration is incorrect, or if In App messaging hasn't been initialized.
+ * @returns {OnMessageDismissedOutput} - An object that holds a remove method to stop listening to events.
+ * @example
+ * ```ts
+ * onMessageDisplayed((message) => {
+ *   // use the message
+ * 	 console.log(message.id);
+ * });
+ * ```
+ */
+export declare function onMessageDisplayed(input: OnMessageDisplayedInput): OnMessageDisplayedOutput;

package/lib-esm/inAppMessaging/providers/pinpoint/apis/onMessageDisplayed.js

@@ -0,0 +1,23 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { addEventListener } from '../../../../eventListeners';
+import { assertIsInitialized } from '../../../utils';
+/**
+ * Registers a callback that will be invoked on `messageDisplayed` events.
+ *
+ * @param {OnMessageDisplayedInput} input - The input object that holds the callback handler.
+ * @throws validation: {@link InAppMessagingValidationErrorCode} - Thrown when the provided parameters or library
+ * configuration is incorrect, or if In App messaging hasn't been initialized.
+ * @returns {OnMessageDismissedOutput} - An object that holds a remove method to stop listening to events.
+ * @example
+ * ```ts
+ * onMessageDisplayed((message) => {
+ *   // use the message
+ * 	 console.log(message.id);
+ * });
+ * ```
+ */
+export function onMessageDisplayed(input) {
+    assertIsInitialized();
+    return addEventListener('messageDisplayed', input);
+}

package/lib-esm/inAppMessaging/providers/pinpoint/apis/onMessageReceived.d.ts

@@ -0,0 +1,18 @@
+import { OnMessageReceivedInput } from '../types/inputs';
+import { OnMessageReceivedOutput } from '../types/outputs';
+/**
+ * Registers a callback that will be invoked on `messageReceived` events.
+ *
+ * @param {OnMessageReceivedInput} input - The input object that holds the callback handler.
+ * @throws validation: {@link InAppMessagingValidationErrorCode} - Thrown when the provided parameters or library
+ * configuration is incorrect, or if In App messaging hasn't been initialized.
+ * @returns {OnMessageReceivedOutput} - An object that holds a remove method to stop listening to events.
+ * @example
+ * ```ts
+ * onMessageReceived((message) => {
+ *   // use the message
+ *   console.log(message.id);
+ * });
+ * ```
+ */
+export declare function onMessageReceived(input: OnMessageReceivedInput): OnMessageReceivedOutput;

package/lib-esm/inAppMessaging/providers/pinpoint/apis/onMessageReceived.js

@@ -0,0 +1,23 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { addEventListener } from '../../../../eventListeners';
+import { assertIsInitialized } from '../../../utils';
+/**
+ * Registers a callback that will be invoked on `messageReceived` events.
+ *
+ * @param {OnMessageReceivedInput} input - The input object that holds the callback handler.
+ * @throws validation: {@link InAppMessagingValidationErrorCode} - Thrown when the provided parameters or library
+ * configuration is incorrect, or if In App messaging hasn't been initialized.
+ * @returns {OnMessageReceivedOutput} - An object that holds a remove method to stop listening to events.
+ * @example
+ * ```ts
+ * onMessageReceived((message) => {
+ *   // use the message
+ *   console.log(message.id);
+ * });
+ * ```
+ */
+export function onMessageReceived(input) {
+    assertIsInitialized();
+    return addEventListener('messageReceived', input);
+}

package/lib-esm/inAppMessaging/providers/pinpoint/apis/setConflictHandler.d.ts

@@ -0,0 +1,32 @@
+import { InAppMessageConflictHandler, SetConflictHandlerInput } from '../types';
+export declare let conflictHandler: InAppMessageConflictHandler;
+/**
+ * Set a conflict handler that will be used to resolve conflicts that may emerge
+ * when matching events with synced messages.
+ *
+ * @remark
+ * The conflict handler is not persisted across app restarts and so must be set again before dispatching an event for
+ * any custom handling to take effect.
+ * @throws validation: {@link InAppMessagingValidationErrorCode} - Thrown when the provided parameters or library
+ * configuration is incorrect, or if In App messaging hasn't been initialized.
+ * @param SetConflictHandlerInput: The input object that holds the conflict handler to be used.
+ * @example
+ * ```ts
+ * // Sync messages before dispatching an event
+ * await syncMessages();
+ *
+ * // Example custom conflict handler
+ * const myConflictHandler = (messages) => {
+ * 		// Return a random message
+ * 		const randomIndex = Math.floor(Math.random() * messages.length);
+ * 		return messages[randomIndex];
+ *  };
+ *
+ * // Set the conflict handler
+ * setConflictHandler(myConflictHandler);
+ *
+ * // Dispatch an event
+ * await dispatchEvent({ name: 'test_event' });
+ * ```
+ */
+export declare function setConflictHandler(input: SetConflictHandlerInput): void;

package/lib-esm/inAppMessaging/providers/pinpoint/apis/setConflictHandler.js

@@ -0,0 +1,61 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { assertIsInitialized } from '../../../utils';
+export let conflictHandler = defaultConflictHandler;
+/**
+ * Set a conflict handler that will be used to resolve conflicts that may emerge
+ * when matching events with synced messages.
+ *
+ * @remark
+ * The conflict handler is not persisted across app restarts and so must be set again before dispatching an event for
+ * any custom handling to take effect.
+ * @throws validation: {@link InAppMessagingValidationErrorCode} - Thrown when the provided parameters or library
+ * configuration is incorrect, or if In App messaging hasn't been initialized.
+ * @param SetConflictHandlerInput: The input object that holds the conflict handler to be used.
+ * @example
+ * ```ts
+ * // Sync messages before dispatching an event
+ * await syncMessages();
+ *
+ * // Example custom conflict handler
+ * const myConflictHandler = (messages) => {
+ * 		// Return a random message
+ * 		const randomIndex = Math.floor(Math.random() * messages.length);
+ * 		return messages[randomIndex];
+ *  };
+ *
+ * // Set the conflict handler
+ * setConflictHandler(myConflictHandler);
+ *
+ * // Dispatch an event
+ * await dispatchEvent({ name: 'test_event' });
+ * ```
+ */
+export function setConflictHandler(input) {
+    assertIsInitialized();
+    conflictHandler = input;
+}
+function defaultConflictHandler(messages) {
+    // default behavior is to return the message closest to expiry
+    // this function assumes that messages processed by providers already filters out expired messages
+    const sorted = messages.sort((a, b) => {
+        const endDateA = a.metadata?.endDate;
+        const endDateB = b.metadata?.endDate;
+        // if both message end dates are falsy or have the same date string, treat them as equal
+        if (endDateA === endDateB) {
+            return 0;
+        }
+        // if only message A has an end date, treat it as closer to expiry
+        if (endDateA && !endDateB) {
+            return -1;
+        }
+        // if only message B has an end date, treat it as closer to expiry
+        if (!endDateA && endDateB) {
+            return 1;
+        }
+        // otherwise, compare them
+        return new Date(endDateA) < new Date(endDateB) ? -1 : 1;
+    });
+    // always return the top sorted
+    return sorted[0];
+}

package/lib-esm/inAppMessaging/providers/pinpoint/apis/syncMessages.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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, or if In App messaging hasn't been initialized.
+ * @returns A promise that will resolve when the operation is complete.
+ * @example
+ * ```ts
+ * // Sync InApp messages with Pinpoint and device.
+ * await syncMessages();
+ *
+ * ```
+ */
+export declare function syncMessages(): Promise<void>;