@aws-amplify/notifications 2.0.1-api-v6-models.8035dfc.0 → 2.0.1-api-v6-models.3eb7748.0

package/lib-esm/{common/eventListeners/index.d.ts → eventListeners/eventListeners.d.ts}

@@ -1,4 +1,4 @@
-import { EventListener, EventType } from './types';
+import { EventListenerRemover, EventType } from './types';
 export declare const notifyEventListeners: (type: EventType, ...args: any[]) => void;
 export declare const notifyEventListenersAndAwaitHandlers: (type: EventType, ...args: any[]) => Promise<void[]>;
-export declare const addEventListener: <EventHandler extends Function>(type: EventType, handler: EventHandler) => EventListener<EventHandler>;
+export declare const addEventListener: <EventHandler extends Function>(type: EventType, handler: EventHandler) => EventListenerRemover;

package/lib-esm/{common/eventListeners/index.js → eventListeners/eventListeners.js}

@@ -48,6 +48,7 @@ export var addEventListener = function (type, handler) {
         },
     };
     eventListeners[type].add(listener);
-    return listener;
+    return {
+        remove: function () { return listener.remove(); },
+    };
 };
-//# sourceMappingURL=index.js.map

package/lib-esm/eventListeners/index.d.ts

@@ -0,0 +1,2 @@
+export { addEventListener, notifyEventListeners, notifyEventListenersAndAwaitHandlers, } from './eventListeners';
+export { EventListener, EventType, EventListenerRemover } from './types';

package/lib-esm/{common → eventListeners}/index.js

@@ -1,5 +1,3 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-export { default as AWSPinpointProviderCommon } from './AWSPinpointProviderCommon';
 export { addEventListener, notifyEventListeners, notifyEventListenersAndAwaitHandlers, } from './eventListeners';
-//# sourceMappingURL=index.js.map

package/lib-esm/eventListeners/types.d.ts

@@ -0,0 +1,10 @@
+import { InAppMessageInteractionEvent } from '../inAppMessaging/types';
+import { PushNotificationEvent } from '../pushNotifications/types';
+export interface EventListener<EventHandler extends Function> {
+    handleEvent: EventHandler;
+    remove: () => void;
+}
+export declare type EventType = InAppMessageInteractionEvent | PushNotificationEvent;
+export declare type EventListenerRemover = {
+    remove: () => void;
+};

package/lib-esm/{common/AWSPinpointProviderCommon → eventListeners}/types.js

@@ -1,3 +1,2 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-//# sourceMappingURL=types.js.map

package/lib-esm/inAppMessaging/errors/InAppMessagingError.js

@@ -18,4 +18,3 @@ var InAppMessagingError = /** @class */ (function (_super) {
     return InAppMessagingError;
 }(AmplifyError));
 export { InAppMessagingError };
-//# sourceMappingURL=InAppMessagingError.js.map

package/lib-esm/inAppMessaging/errors/assertServiceError.js

@@ -13,4 +13,3 @@ export function assertServiceError(error) {
         });
     }
 }
-//# sourceMappingURL=assertServiceError.js.map

package/lib-esm/inAppMessaging/errors/assertValidationError.js

@@ -11,4 +11,3 @@ export function assertValidationError(assertion, name) {
         throw new InAppMessagingError({ name: name, message: message, recoverySuggestion: recoverySuggestion });
     }
 }
-//# sourceMappingURL=assertValidationError.js.map

package/lib-esm/inAppMessaging/errors/index.js

@@ -4,4 +4,3 @@ export { InAppMessagingError } from './InAppMessagingError';
 export { assertValidationError } from './assertValidationError';
 export { assertServiceError } from './assertServiceError';
 export { InAppMessagingValidationErrorCode, validationErrorMap, } from './validation';
-//# sourceMappingURL=index.js.map

package/lib-esm/inAppMessaging/errors/validation.d.ts

@@ -3,6 +3,6 @@ export declare enum InAppMessagingValidationErrorCode {
     NoAppId = "NoAppId",
     NoCredentials = "NoCredentials",
     NoRegion = "NoRegion",
-    NoEndpointId = "NoEndpointId"
+    NotInitialized = "NotInitialized"
 }
 export declare const validationErrorMap: AmplifyErrorMap<InAppMessagingValidationErrorCode>;

package/lib-esm/inAppMessaging/errors/validation.js

@@ -6,7 +6,7 @@ export var InAppMessagingValidationErrorCode;
     InAppMessagingValidationErrorCode["NoAppId"] = "NoAppId";
     InAppMessagingValidationErrorCode["NoCredentials"] = "NoCredentials";
     InAppMessagingValidationErrorCode["NoRegion"] = "NoRegion";
-    InAppMessagingValidationErrorCode["NoEndpointId"] = "NoEndpointId";
+    InAppMessagingValidationErrorCode["NotInitialized"] = "NotInitialized";
 })(InAppMessagingValidationErrorCode || (InAppMessagingValidationErrorCode = {}));
 export var validationErrorMap = (_a = {},
     _a[InAppMessagingValidationErrorCode.NoAppId] = {
@@ -18,8 +18,8 @@ export var validationErrorMap = (_a = {},
     _a[InAppMessagingValidationErrorCode.NoRegion] = {
         message: 'Missing region.',
     },
-    _a[InAppMessagingValidationErrorCode.NoEndpointId] = {
-        message: 'Could not find or create EndpointId.',
+    _a[InAppMessagingValidationErrorCode.NotInitialized] = {
+        message: 'In-app messaging has not been initialized.',
+        recoverySuggestion: 'Please make sure to first call `initializePushNotifications`.',
     },
     _a);
-//# sourceMappingURL=validation.js.map

package/lib-esm/inAppMessaging/index.d.ts

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

package/lib-esm/inAppMessaging/index.js

@@ -1,4 +1,3 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-export { identifyUser, syncMessages, dispatchEvent, setConflictHandler, } from './providers/pinpoint';
-//# sourceMappingURL=index.js.map
+export { identifyUser, syncMessages, dispatchEvent, setConflictHandler, initializeInAppMessaging, onMessageReceived, onMessageDisplayed, onMessageDismissed, onMessageActionTaken, notifyMessageInteraction, } from './providers/pinpoint';

package/lib-esm/inAppMessaging/providers/index.d.ts

@@ -1 +1,2 @@
-export { identifyUser, syncMessages, dispatchEvent, setConflictHandler, } from './pinpoint/apis';
+export { identifyUser, syncMessages, dispatchEvent, setConflictHandler, initializeInAppMessaging, onMessageReceived, onMessageDisplayed, onMessageDismissed, onMessageActionTaken, notifyMessageInteraction, IdentifyUserInput, DispatchEventInput, SetConflictHandlerInput, OnMessageActionTakenInput, OnMessageDismissedInput, OnMessageDisplayedInput, OnMessageReceivedInput, NotifyMessageInteractionInput, OnMessageReceivedOutput, OnMessageActionTakenOutput, OnMessageDismissedOutput, OnMessageDisplayedOutput, } from './pinpoint';
+export { InAppMessage, InAppMessageAction, InAppMessageContent, InAppMessageLayout, InAppMessageTextAlign, InAppMessageButton, InAppMessageImage, InAppMessageStyle, } from '../types';

package/lib-esm/inAppMessaging/providers/index.js

@@ -1,4 +1,3 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-export { identifyUser, syncMessages, dispatchEvent, setConflictHandler, } from './pinpoint/apis';
-//# sourceMappingURL=index.js.map
+export { identifyUser, syncMessages, dispatchEvent, setConflictHandler, initializeInAppMessaging, onMessageReceived, onMessageDisplayed, onMessageDismissed, onMessageActionTaken, notifyMessageInteraction, } from './pinpoint';

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

@@ -3,21 +3,24 @@ 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.
- * To change the conflict handler, use the {@link setConflictHandler} API.
  *
- * @param DispatchEventInput The input object that holds the event to be dispatched.
+ * @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" });
+ * await dispatchEvent({ name: 'test_event' });
  * ```
  */
 export declare function dispatchEvent(input: DispatchEventInput): Promise<void>;

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

@@ -4,28 +4,32 @@ import { __awaiter, __generator } from "tslib";
 import { PINPOINT_KEY_PREFIX, STORAGE_KEY_SUFFIX, processInAppMessages, } from '../utils';
 import flatten from 'lodash/flatten';
 import { defaultStorage } from '@aws-amplify/core';
-import { notifyEventListeners } from '../../../../common';
+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.
- * To change the conflict handler, use the {@link setConflictHandler} API.
  *
- * @param DispatchEventInput The input object that holds the event to be dispatched.
+ * @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" });
+ * await dispatchEvent({ name: 'test_event' });
  * ```
  */
 export function dispatchEvent(input) {
@@ -34,26 +38,28 @@ export function dispatchEvent(input) {
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
-                    _a.trys.push([0, 3, , 4]);
+                    assertIsInitialized();
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 4, , 5]);
                     key = "" + PINPOINT_KEY_PREFIX + STORAGE_KEY_SUFFIX;
                     return [4 /*yield*/, defaultStorage.getItem(key)];
-                case 1:
+                case 2:
                     cachedMessages = _a.sent();
                     return [4 /*yield*/, processInAppMessages(cachedMessages ? JSON.parse(cachedMessages) : [], input)];
-                case 2:
+                case 3:
                     messages = _a.sent();
                     flattenedMessages = flatten(messages);
                     if (flattenedMessages.length > 0) {
                         notifyEventListeners('messageReceived', conflictHandler(flattenedMessages));
                     }
-                    return [3 /*break*/, 4];
-                case 3:
+                    return [3 /*break*/, 5];
+                case 4:
                     error_1 = _a.sent();
                     assertServiceError(error_1);
                     throw error_1;
-                case 4: return [2 /*return*/];
+                case 5: return [2 /*return*/];
             }
         });
     });
 }
-//# sourceMappingURL=dispatchEvent.js.map

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

@@ -5,13 +5,10 @@
  *
  * @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.
- *
+ * 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
@@ -42,12 +39,10 @@
  *         }
  *     },
  *     options: {
- *         serviceOptions: {
- *             address: 'device-address',
- *             optOut: 'NONE',
- * 			   userAttributes: {
- * 			      interests: ['food']
- * 			   },
+ *         address: 'device-address',
+ *         optOut: 'NONE',
+ *         userAttributes: {
+ *             interests: ['food']
  *         },
  *     },
  * });

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

@@ -2,8 +2,9 @@
 // SPDX-License-Identifier: Apache-2.0
 import { __awaiter, __generator } from "tslib";
 import { InAppMessagingAction } from '@aws-amplify/core/internals/utils';
-import { updateEndpoint } from '@aws-amplify/core/internals/providers/pinpoint';
+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
@@ -11,13 +12,10 @@ import { CATEGORY, CHANNEL_TYPE, getInAppMessagingUserAgentString, resolveConfig
  *
  * @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.
- *
+ * 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
@@ -48,12 +46,10 @@ import { CATEGORY, CHANNEL_TYPE, getInAppMessagingUserAgentString, resolveConfig
  *         }
  *     },
  *     options: {
- *         serviceOptions: {
- *             address: 'device-address',
- *             optOut: 'NONE',
- * 			   userAttributes: {
- * 			      interests: ['food']
- * 			   },
+ *         address: 'device-address',
+ *         optOut: 'NONE',
+ *         userAttributes: {
+ *             interests: ['food']
  *         },
  *     },
  * });
@@ -62,14 +58,15 @@ export var identifyUser = function (_a) {
     var userId = _a.userId, userProfile = _a.userProfile, options = _a.options;
     return __awaiter(void 0, void 0, void 0, function () {
         var _b, credentials, identityId, _c, appId, region, _d, address, optOut, userAttributes;
-        var _e;
-        return __generator(this, function (_f) {
-            switch (_f.label) {
-                case 0: return [4 /*yield*/, resolveCredentials()];
+        return __generator(this, function (_e) {
+            switch (_e.label) {
+                case 0:
+                    assertIsInitialized();
+                    return [4 /*yield*/, resolveCredentials()];
                 case 1:
-                    _b = _f.sent(), credentials = _b.credentials, identityId = _b.identityId;
+                    _b = _e.sent(), credentials = _b.credentials, identityId = _b.identityId;
                     _c = resolveConfig(), appId = _c.appId, region = _c.region;
-                    _d = (_e = options === null || options === void 0 ? void 0 : options.serviceOptions) !== null && _e !== void 0 ? _e : {}, address = _d.address, optOut = _d.optOut, userAttributes = _d.userAttributes;
+                    _d = options !== null && options !== void 0 ? options : {}, address = _d.address, optOut = _d.optOut, userAttributes = _d.userAttributes;
                     updateEndpoint({
                         address: address,
                         channelType: CHANNEL_TYPE,
@@ -89,4 +86,3 @@ export var identifyUser = function (_a) {
         });
     });
 };
-//# sourceMappingURL=identifyUser.js.map

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

@@ -2,3 +2,9 @@ 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';

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

@@ -4,4 +4,9 @@ export { identifyUser } from './identifyUser';
 export { syncMessages } from './syncMessages';
 export { dispatchEvent } from './dispatchEvent';
 export { setConflictHandler } from './setConflictHandler';
-//# sourceMappingURL=index.js.map
+export { initializeInAppMessaging } from './initializeInAppMessaging';
+export { onMessageReceived } from './onMessageReceived';
+export { onMessageDismissed } from './onMessageDismissed';
+export { onMessageDisplayed } from './onMessageDisplayed';
+export { onMessageActionTaken } from './onMessageActionTaken';
+export { notifyMessageInteraction } from './notifyMessageInteraction';

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,54 @@
+// 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', function (message) {
+        recordAnalyticsEvent(PinpointMessageEvent.MESSAGE_DISPLAYED, message);
+        incrementMessageCounts(message.id);
+    });
+    addEventListener('messageDismissed', function (message) {
+        recordAnalyticsEvent(PinpointMessageEvent.MESSAGE_DISMISSED, message);
+    });
+    addEventListener('messageActionTaken', function (message) {
+        recordAnalyticsEvent(PinpointMessageEvent.MESSAGE_ACTION_TAKEN, message);
+    });
+    // listen to analytics hub events
+    Hub.listen('analytics', analyticsListener);
+    initialize();
+}
+function analyticsListener(_a) {
+    var payload = _a.payload;
+    var event = payload.event, data = payload.data;
+    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,23 @@
+// 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(_a) {
+    var type = _a.type, message = _a.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;