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

package/lib/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/inAppMessaging/providers/pinpoint/apis/notifyMessageInteraction.js

@@ -0,0 +1,26 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.notifyMessageInteraction = void 0;
+const eventListeners_1 = require("../../../../eventListeners");
+const utils_1 = require("../../../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 });
+ * });
+ * ```
+ */
+function notifyMessageInteraction({ type, message, }) {
+    (0, utils_1.assertIsInitialized)();
+    (0, eventListeners_1.notifyEventListeners)(type, message);
+}
+exports.notifyMessageInteraction = notifyMessageInteraction;

package/lib/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/inAppMessaging/providers/pinpoint/apis/onMessageActionTaken.js

@@ -0,0 +1,27 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onMessageActionTaken = void 0;
+const eventListeners_1 = require("../../../../eventListeners");
+const utils_1 = require("../../../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);
+ * });
+ * ```
+ */
+function onMessageActionTaken(input) {
+    (0, utils_1.assertIsInitialized)();
+    return (0, eventListeners_1.addEventListener)('messageActionTaken', input);
+}
+exports.onMessageActionTaken = onMessageActionTaken;

package/lib/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/inAppMessaging/providers/pinpoint/apis/onMessageDismissed.js

@@ -0,0 +1,27 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onMessageDismissed = void 0;
+const eventListeners_1 = require("../../../../eventListeners");
+const utils_1 = require("../../../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);
+ * });
+ * ```
+ */
+function onMessageDismissed(input) {
+    (0, utils_1.assertIsInitialized)();
+    return (0, eventListeners_1.addEventListener)('messageDismissed', input);
+}
+exports.onMessageDismissed = onMessageDismissed;

package/lib/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/inAppMessaging/providers/pinpoint/apis/onMessageDisplayed.js

@@ -0,0 +1,27 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onMessageDisplayed = void 0;
+const eventListeners_1 = require("../../../../eventListeners");
+const utils_1 = require("../../../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);
+ * });
+ * ```
+ */
+function onMessageDisplayed(input) {
+    (0, utils_1.assertIsInitialized)();
+    return (0, eventListeners_1.addEventListener)('messageDisplayed', input);
+}
+exports.onMessageDisplayed = onMessageDisplayed;

package/lib/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/inAppMessaging/providers/pinpoint/apis/onMessageReceived.js

@@ -0,0 +1,27 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onMessageReceived = void 0;
+const eventListeners_1 = require("../../../../eventListeners");
+const utils_1 = require("../../../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);
+ * });
+ * ```
+ */
+function onMessageReceived(input) {
+    (0, utils_1.assertIsInitialized)();
+    return (0, eventListeners_1.addEventListener)('messageReceived', input);
+}
+exports.onMessageReceived = onMessageReceived;

package/lib/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/inAppMessaging/providers/pinpoint/apis/setConflictHandler.js

@@ -0,0 +1,65 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setConflictHandler = exports.conflictHandler = void 0;
+const utils_1 = require("../../../utils");
+exports.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' });
+ * ```
+ */
+function setConflictHandler(input) {
+    (0, utils_1.assertIsInitialized)();
+    exports.conflictHandler = input;
+}
+exports.setConflictHandler = setConflictHandler;
+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/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>;

package/lib/inAppMessaging/providers/pinpoint/apis/syncMessages.js

@@ -0,0 +1,69 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.syncMessages = void 0;
+const utils_1 = require("@aws-amplify/core/internals/utils");
+const pinpoint_1 = require("@aws-amplify/core/internals/providers/pinpoint");
+const core_1 = require("@aws-amplify/core");
+const utils_2 = require("../utils");
+const pinpoint_2 = require("@aws-amplify/core/internals/aws-clients/pinpoint");
+const errors_1 = require("../../../errors");
+const utils_3 = require("../../../utils");
+/**
+ * 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();
+ *
+ * ```
+ */
+async function syncMessages() {
+    (0, utils_3.assertIsInitialized)();
+    const messages = await fetchInAppMessages();
+    if (!messages || messages.length === 0) {
+        return;
+    }
+    try {
+        const key = `${utils_2.PINPOINT_KEY_PREFIX}${utils_2.STORAGE_KEY_SUFFIX}`;
+        await core_1.defaultStorage.setItem(key, JSON.stringify(messages));
+    }
+    catch (error) {
+        (0, errors_1.assertServiceError)(error);
+        throw error;
+    }
+}
+exports.syncMessages = syncMessages;
+async function fetchInAppMessages() {
+    try {
+        const { credentials, identityId } = await (0, utils_2.resolveCredentials)();
+        const { appId, region } = (0, utils_2.resolveConfig)();
+        const endpointId = await (0, pinpoint_1.resolveEndpointId)({
+            appId,
+            category: utils_2.CATEGORY,
+            channelType: utils_2.CHANNEL_TYPE,
+            credentials,
+            identityId,
+            region,
+            userAgentValue: (0, utils_2.getInAppMessagingUserAgentString)(utils_1.InAppMessagingAction.SyncMessages),
+        });
+        const input = {
+            ApplicationId: appId,
+            EndpointId: endpointId,
+        };
+        const response = await (0, pinpoint_2.getInAppMessages)({ credentials, region }, input);
+        const { InAppMessageCampaigns: messages } = response.InAppMessagesResponse ?? {};
+        return messages;
+    }
+    catch (error) {
+        (0, errors_1.assertServiceError)(error);
+        throw error;
+    }
+}

package/lib/inAppMessaging/providers/pinpoint/index.d.ts

@@ -0,0 +1,2 @@
+export { identifyUser, syncMessages, dispatchEvent, setConflictHandler, initializeInAppMessaging, onMessageReceived, onMessageDisplayed, onMessageDismissed, onMessageActionTaken, notifyMessageInteraction, clearMessages, } from './apis';
+export { IdentifyUserInput, DispatchEventInput, SetConflictHandlerInput, OnMessageActionTakenInput, OnMessageDismissedInput, OnMessageDisplayedInput, OnMessageReceivedInput, NotifyMessageInteractionInput, OnMessageReceivedOutput, OnMessageActionTakenOutput, OnMessageDismissedOutput, OnMessageDisplayedOutput, } from './types';

package/lib/inAppMessaging/providers/pinpoint/index.js

@@ -0,0 +1,17 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearMessages = exports.notifyMessageInteraction = exports.onMessageActionTaken = exports.onMessageDismissed = exports.onMessageDisplayed = exports.onMessageReceived = exports.initializeInAppMessaging = exports.setConflictHandler = exports.dispatchEvent = exports.syncMessages = exports.identifyUser = void 0;
+var apis_1 = require("./apis");
+Object.defineProperty(exports, "identifyUser", { enumerable: true, get: function () { return apis_1.identifyUser; } });
+Object.defineProperty(exports, "syncMessages", { enumerable: true, get: function () { return apis_1.syncMessages; } });
+Object.defineProperty(exports, "dispatchEvent", { enumerable: true, get: function () { return apis_1.dispatchEvent; } });
+Object.defineProperty(exports, "setConflictHandler", { enumerable: true, get: function () { return apis_1.setConflictHandler; } });
+Object.defineProperty(exports, "initializeInAppMessaging", { enumerable: true, get: function () { return apis_1.initializeInAppMessaging; } });
+Object.defineProperty(exports, "onMessageReceived", { enumerable: true, get: function () { return apis_1.onMessageReceived; } });
+Object.defineProperty(exports, "onMessageDisplayed", { enumerable: true, get: function () { return apis_1.onMessageDisplayed; } });
+Object.defineProperty(exports, "onMessageDismissed", { enumerable: true, get: function () { return apis_1.onMessageDismissed; } });
+Object.defineProperty(exports, "onMessageActionTaken", { enumerable: true, get: function () { return apis_1.onMessageActionTaken; } });
+Object.defineProperty(exports, "notifyMessageInteraction", { enumerable: true, get: function () { return apis_1.notifyMessageInteraction; } });
+Object.defineProperty(exports, "clearMessages", { enumerable: true, get: function () { return apis_1.clearMessages; } });

package/lib/inAppMessaging/providers/pinpoint/types/index.d.ts

@@ -0,0 +1,4 @@
+export { IdentifyUserInput, DispatchEventInput, SetConflictHandlerInput, OnMessageActionTakenInput, OnMessageDismissedInput, OnMessageDisplayedInput, OnMessageReceivedInput, NotifyMessageInteractionInput, } from './inputs';
+export { OnMessageReceivedOutput, OnMessageActionTakenOutput, OnMessageDismissedOutput, OnMessageDisplayedOutput, } from './outputs';
+export { IdentifyUserOptions } from './options';
+export { PinpointMessageEvent, MetricsComparator, InAppMessageCounts, InAppMessageCountMap, DailyInAppMessageCounter, InAppMessageConflictHandler, OnMessageInteractionEventHandler, } from './types';

package/lib/{InAppMessaging → inAppMessaging/providers/pinpoint/types}/index.js

@@ -2,8 +2,6 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
-var InAppMessaging_1 = require("./InAppMessaging");
-exports.default = InAppMessaging_1.default;
+exports.PinpointMessageEvent = void 0;
 var types_1 = require("./types");
-exports.InAppMessageInteractionEvent = types_1.InAppMessageInteractionEvent;
-//# sourceMappingURL=index.js.map
+Object.defineProperty(exports, "PinpointMessageEvent", { enumerable: true, get: function () { return types_1.PinpointMessageEvent; } });

package/lib/inAppMessaging/providers/pinpoint/types/inputs.d.ts

@@ -0,0 +1,37 @@
+import { IdentifyUserOptions, InAppMessageConflictHandler, OnMessageInteractionEventHandler } from '.';
+import { InAppMessage, InAppMessageInteractionEvent, InAppMessagingEvent, InAppMessagingIdentifyUserInput } from '../../../types';
+/**
+ * Input type for Pinpoint identifyUser API.
+ */
+export type IdentifyUserInput = InAppMessagingIdentifyUserInput<IdentifyUserOptions>;
+/**
+ * Input type for Pinpoint dispatchEvent API.
+ */
+export type DispatchEventInput = InAppMessagingEvent;
+/**
+ * Input type for Pinpoint SetConflictHandler API.
+ */
+export type SetConflictHandlerInput = InAppMessageConflictHandler;
+/**
+ * Input type for OnMessageReceived API.
+ */
+export type OnMessageReceivedInput = OnMessageInteractionEventHandler;
+/**
+ * Input type for OnMessageDisplayed API.
+ */
+export type OnMessageDisplayedInput = OnMessageInteractionEventHandler;
+/**
+ * Input type for OnMessageDismissed API.
+ */
+export type OnMessageDismissedInput = OnMessageInteractionEventHandler;
+/**
+ * Input type for OnMessageActionTaken API.
+ */
+export type OnMessageActionTakenInput = OnMessageInteractionEventHandler;
+/**
+ * Input type for NotifyMessageInteraction API.
+ */
+export type NotifyMessageInteractionInput = {
+    message: InAppMessage;
+    type: InAppMessageInteractionEvent;
+};

package/lib/{PushNotification/Platform/types.js → inAppMessaging/providers/pinpoint/types/inputs.js}

@@ -2,4 +2,3 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=types.js.map

package/lib/inAppMessaging/providers/pinpoint/types/options.d.ts

@@ -0,0 +1,5 @@
+import { PinpointServiceOptions } from '@aws-amplify/core/internals/providers/pinpoint';
+/**
+ * Options specific to Pinpoint identityUser.
+ */
+export type IdentifyUserOptions = PinpointServiceOptions;

package/lib/{common/AWSPinpointProviderCommon/types.js → inAppMessaging/providers/pinpoint/types/options.js}

@@ -2,4 +2,3 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=types.js.map

package/lib/inAppMessaging/providers/pinpoint/types/outputs.d.ts

@@ -0,0 +1,17 @@
+import { EventListenerRemover } from '../../../../eventListeners';
+/**
+ * Output type for OnMessageReceived API.
+ */
+export type OnMessageReceivedOutput = EventListenerRemover;
+/**
+ * Output type for OnMessageDisplayed API.
+ */
+export type OnMessageDisplayedOutput = EventListenerRemover;
+/**
+ * Output type for OnMessageDismissed API.
+ */
+export type OnMessageDismissedOutput = EventListenerRemover;
+/**
+ * Output type for OnMessageActionTaken API.
+ */
+export type OnMessageActionTakenOutput = EventListenerRemover;

package/lib/{common/eventListeners/types.js → inAppMessaging/providers/pinpoint/types/outputs.js}

@@ -2,4 +2,3 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=types.js.map

package/lib/inAppMessaging/providers/pinpoint/types/types.d.ts

@@ -0,0 +1,19 @@
+import { InAppMessage } from '../../../types';
+export type InAppMessageCountMap = Record<string, number>;
+export type DailyInAppMessageCounter = {
+    count: number;
+    lastCountTimestamp: string;
+};
+export type InAppMessageCounts = {
+    sessionCount: number;
+    dailyCount: number;
+    totalCount: number;
+};
+export type MetricsComparator = (metricsVal: number, eventVal: number) => boolean;
+export declare enum PinpointMessageEvent {
+    MESSAGE_DISPLAYED = "_inapp.message_displayed",
+    MESSAGE_DISMISSED = "_inapp.message_dismissed",
+    MESSAGE_ACTION_TAKEN = "_inapp.message_clicked"
+}
+export type InAppMessageConflictHandler = (messages: InAppMessage[]) => InAppMessage;
+export type OnMessageInteractionEventHandler = (message: InAppMessage) => void;

package/lib/inAppMessaging/providers/pinpoint/types/types.js

@@ -0,0 +1,11 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PinpointMessageEvent = void 0;
+var PinpointMessageEvent;
+(function (PinpointMessageEvent) {
+    PinpointMessageEvent["MESSAGE_DISPLAYED"] = "_inapp.message_displayed";
+    PinpointMessageEvent["MESSAGE_DISMISSED"] = "_inapp.message_dismissed";
+    PinpointMessageEvent["MESSAGE_ACTION_TAKEN"] = "_inapp.message_clicked";
+})(PinpointMessageEvent = exports.PinpointMessageEvent || (exports.PinpointMessageEvent = {}));

package/lib/inAppMessaging/providers/pinpoint/utils/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const PINPOINT_KEY_PREFIX = "Pinpoint";
+export declare const STORAGE_KEY_SUFFIX = "_inAppMessages";
+export declare const CATEGORY = "InAppMessaging";
+export declare const CHANNEL_TYPE = "IN_APP";

package/lib/inAppMessaging/providers/pinpoint/utils/constants.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CHANNEL_TYPE = exports.CATEGORY = exports.STORAGE_KEY_SUFFIX = exports.PINPOINT_KEY_PREFIX = void 0;
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+exports.PINPOINT_KEY_PREFIX = 'Pinpoint';
+exports.STORAGE_KEY_SUFFIX = '_inAppMessages';
+exports.CATEGORY = 'InAppMessaging';
+exports.CHANNEL_TYPE = 'IN_APP';

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

@@ -1,18 +1,17 @@
 import { ConsoleLogger } from '@aws-amplify/core';
 import type { InAppMessageCampaign as PinpointInAppMessage } from '@aws-amplify/core/internals/aws-clients/pinpoint';
-import { InAppMessage, InAppMessageContent, InAppMessageLayout, InAppMessagingEvent } from '../../types';
-import { AWSPinpointMessageEvent, MetricsComparator } from './types';
+import { InAppMessage, InAppMessageContent, InAppMessageLayout, InAppMessagingEvent } from '../../../types';
+import { MetricsComparator, PinpointMessageEvent } from '../types';
 export declare const logger: ConsoleLogger;
-export declare const dispatchInAppMessagingEvent: (event: string, data: any, message?: string) => void;
-export declare const recordAnalyticsEvent: (event: AWSPinpointMessageEvent, message: InAppMessage) => void;
+export declare const recordAnalyticsEvent: (event: PinpointMessageEvent, message: InAppMessage) => void;
 export declare const getStartOfDay: () => string;
-export declare const matchesEventType: ({ CampaignId, Schedule }: PinpointInAppMessage, { name: eventType }: InAppMessagingEvent) => any;
+export declare const matchesEventType: ({ CampaignId, Schedule }: PinpointInAppMessage, { name: eventType }: InAppMessagingEvent) => boolean;
 export declare const matchesAttributes: ({ CampaignId, Schedule }: PinpointInAppMessage, { attributes }: InAppMessagingEvent) => boolean;
 export declare const matchesMetrics: ({ CampaignId, Schedule }: PinpointInAppMessage, { metrics }: InAppMessagingEvent) => boolean;
-export declare const getComparator: (operator: string) => MetricsComparator;
+export declare const getComparator: (operator?: string) => MetricsComparator | undefined;
 export declare const isBeforeEndDate: ({ Schedule, }: PinpointInAppMessage) => boolean;
 export declare const isQuietTime: (message: PinpointInAppMessage) => boolean;
 export declare const clearMemo: () => void;
-export declare const interpretLayout: (layout: string) => InAppMessageLayout;
+export declare const interpretLayout: (layout: NonNullable<PinpointInAppMessage['InAppMessage']>['Layout']) => InAppMessageLayout;
 export declare const extractContent: ({ InAppMessage: message, }: PinpointInAppMessage) => InAppMessageContent[];
 export declare const extractMetadata: ({ InAppMessage, Priority, Schedule, TreatmentId, }: PinpointInAppMessage) => any;