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

package/README.md

@@ -0,0 +1,3 @@
+> INTERNAL USE ONLY
+
+This package contains the AWS Amplify Notifications category and is intended for internal use only. To integrate Amplify into your app, please use [aws-amplify](https://www.npmjs.com/package/aws-amplify).

package/in-app-messaging/package.json

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

package/in-app-messaging/pinpoint/package.json

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

package/lib/{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/eventListeners/eventListeners.js

@@ -0,0 +1,38 @@
+"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.addEventListener = exports.notifyEventListenersAndAwaitHandlers = exports.notifyEventListeners = void 0;
+const eventListeners = {};
+const notifyEventListeners = (type, ...args) => {
+    eventListeners[type]?.forEach(listener => {
+        listener.handleEvent(...args);
+    });
+};
+exports.notifyEventListeners = notifyEventListeners;
+const notifyEventListenersAndAwaitHandlers = (type, ...args) => Promise.all(Array.from(eventListeners[type] ?? []).map(async (listener) => {
+    try {
+        await listener.handleEvent(...args);
+    }
+    catch (err) {
+        throw err;
+    }
+}));
+exports.notifyEventListenersAndAwaitHandlers = notifyEventListenersAndAwaitHandlers;
+const addEventListener = (type, handler) => {
+    // If there is no listener set for the event type, just create it
+    if (!eventListeners[type]) {
+        eventListeners[type] = new Set();
+    }
+    const listener = {
+        handleEvent: handler,
+        remove: () => {
+            eventListeners[type].delete(listener);
+        },
+    };
+    eventListeners[type].add(listener);
+    return {
+        remove: () => listener.remove(),
+    };
+};
+exports.addEventListener = addEventListener;

package/lib/eventListeners/index.d.ts

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

package/lib/eventListeners/index.js

@@ -0,0 +1,9 @@
+"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.notifyEventListenersAndAwaitHandlers = exports.notifyEventListeners = exports.addEventListener = void 0;
+var eventListeners_1 = require("./eventListeners");
+Object.defineProperty(exports, "addEventListener", { enumerable: true, get: function () { return eventListeners_1.addEventListener; } });
+Object.defineProperty(exports, "notifyEventListeners", { enumerable: true, get: function () { return eventListeners_1.notifyEventListeners; } });
+Object.defineProperty(exports, "notifyEventListenersAndAwaitHandlers", { enumerable: true, get: function () { return eventListeners_1.notifyEventListenersAndAwaitHandlers; } });

package/lib/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 type EventType = InAppMessageInteractionEvent | PushNotificationEvent;
+export type EventListenerRemover = {
+    remove: () => void;
+};

package/lib/{InAppMessaging/SessionTracker → eventListeners}/types.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/errors/InAppMessagingError.d.ts

@@ -0,0 +1,7 @@
+import { AmplifyError, AmplifyErrorParams } from '@aws-amplify/core/internals/utils';
+/**
+ * @internal
+ */
+export declare class InAppMessagingError extends AmplifyError {
+    constructor(params: AmplifyErrorParams);
+}

package/lib/inAppMessaging/errors/InAppMessagingError.js

@@ -0,0 +1,19 @@
+"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.InAppMessagingError = void 0;
+const utils_1 = require("@aws-amplify/core/internals/utils");
+/**
+ * @internal
+ */
+class InAppMessagingError extends utils_1.AmplifyError {
+    constructor(params) {
+        super(params);
+        // Hack for making the custom error class work when transpiled to es5
+        // TODO: Delete the following 2 lines after we change the build target to >= es2015
+        this.constructor = InAppMessagingError;
+        Object.setPrototypeOf(this, InAppMessagingError.prototype);
+    }
+}
+exports.InAppMessagingError = InAppMessagingError;

package/lib/inAppMessaging/errors/assertServiceError.d.ts

@@ -0,0 +1,2 @@
+import { ServiceError } from '@aws-amplify/core/internals/utils';
+export declare function assertServiceError(error: unknown): asserts error is ServiceError;

package/lib/inAppMessaging/errors/assertServiceError.js

@@ -0,0 +1,19 @@
+"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.assertServiceError = void 0;
+const utils_1 = require("@aws-amplify/core/internals/utils");
+const InAppMessagingError_1 = require("./InAppMessagingError");
+function assertServiceError(error) {
+    if (!error ||
+        error.name === 'Error' ||
+        error instanceof TypeError) {
+        throw new InAppMessagingError_1.InAppMessagingError({
+            name: utils_1.AmplifyErrorCode.Unknown,
+            message: 'An unknown error has ocurred.',
+            underlyingError: error,
+        });
+    }
+}
+exports.assertServiceError = assertServiceError;

package/lib/inAppMessaging/errors/assertValidationError.d.ts

@@ -0,0 +1,5 @@
+import { InAppMessagingValidationErrorCode } from './validation';
+/**
+ * @internal
+ */
+export declare function assertValidationError(assertion: boolean, name: InAppMessagingValidationErrorCode): asserts assertion;

package/lib/inAppMessaging/errors/assertValidationError.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.assertValidationError = void 0;
+const InAppMessagingError_1 = require("./InAppMessagingError");
+const validation_1 = require("./validation");
+/**
+ * @internal
+ */
+function assertValidationError(assertion, name) {
+    const { message, recoverySuggestion } = validation_1.validationErrorMap[name];
+    if (!assertion) {
+        throw new InAppMessagingError_1.InAppMessagingError({ name, message, recoverySuggestion });
+    }
+}
+exports.assertValidationError = assertValidationError;

package/lib/inAppMessaging/errors/index.d.ts

@@ -0,0 +1,4 @@
+export { InAppMessagingError } from './InAppMessagingError';
+export { assertValidationError } from './assertValidationError';
+export { assertServiceError } from './assertServiceError';
+export { InAppMessagingValidationErrorCode, validationErrorMap, } from './validation';

package/lib/inAppMessaging/errors/index.js

@@ -0,0 +1,14 @@
+"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.validationErrorMap = exports.InAppMessagingValidationErrorCode = exports.assertServiceError = exports.assertValidationError = exports.InAppMessagingError = void 0;
+var InAppMessagingError_1 = require("./InAppMessagingError");
+Object.defineProperty(exports, "InAppMessagingError", { enumerable: true, get: function () { return InAppMessagingError_1.InAppMessagingError; } });
+var assertValidationError_1 = require("./assertValidationError");
+Object.defineProperty(exports, "assertValidationError", { enumerable: true, get: function () { return assertValidationError_1.assertValidationError; } });
+var assertServiceError_1 = require("./assertServiceError");
+Object.defineProperty(exports, "assertServiceError", { enumerable: true, get: function () { return assertServiceError_1.assertServiceError; } });
+var validation_1 = require("./validation");
+Object.defineProperty(exports, "InAppMessagingValidationErrorCode", { enumerable: true, get: function () { return validation_1.InAppMessagingValidationErrorCode; } });
+Object.defineProperty(exports, "validationErrorMap", { enumerable: true, get: function () { return validation_1.validationErrorMap; } });

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

@@ -0,0 +1,8 @@
+import { AmplifyErrorMap } from '@aws-amplify/core/internals/utils';
+export declare enum InAppMessagingValidationErrorCode {
+    NoAppId = "NoAppId",
+    NoCredentials = "NoCredentials",
+    NoRegion = "NoRegion",
+    NotInitialized = "NotInitialized"
+}
+export declare const validationErrorMap: AmplifyErrorMap<InAppMessagingValidationErrorCode>;

package/lib/inAppMessaging/errors/validation.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.validationErrorMap = exports.InAppMessagingValidationErrorCode = void 0;
+var InAppMessagingValidationErrorCode;
+(function (InAppMessagingValidationErrorCode) {
+    InAppMessagingValidationErrorCode["NoAppId"] = "NoAppId";
+    InAppMessagingValidationErrorCode["NoCredentials"] = "NoCredentials";
+    InAppMessagingValidationErrorCode["NoRegion"] = "NoRegion";
+    InAppMessagingValidationErrorCode["NotInitialized"] = "NotInitialized";
+})(InAppMessagingValidationErrorCode = exports.InAppMessagingValidationErrorCode || (exports.InAppMessagingValidationErrorCode = {}));
+exports.validationErrorMap = {
+    [InAppMessagingValidationErrorCode.NoAppId]: {
+        message: 'Missing application id.',
+    },
+    [InAppMessagingValidationErrorCode.NoCredentials]: {
+        message: 'Credentials should not be empty.',
+    },
+    [InAppMessagingValidationErrorCode.NoRegion]: {
+        message: 'Missing region.',
+    },
+    [InAppMessagingValidationErrorCode.NotInitialized]: {
+        message: 'In-app messaging has not been initialized.',
+        recoverySuggestion: 'Please make sure to first call `initializePushNotifications`.',
+    },
+};

package/lib/inAppMessaging/index.d.ts

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

package/lib/inAppMessaging/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 pinpoint_1 = require("./providers/pinpoint");
+Object.defineProperty(exports, "identifyUser", { enumerable: true, get: function () { return pinpoint_1.identifyUser; } });
+Object.defineProperty(exports, "syncMessages", { enumerable: true, get: function () { return pinpoint_1.syncMessages; } });
+Object.defineProperty(exports, "dispatchEvent", { enumerable: true, get: function () { return pinpoint_1.dispatchEvent; } });
+Object.defineProperty(exports, "setConflictHandler", { enumerable: true, get: function () { return pinpoint_1.setConflictHandler; } });
+Object.defineProperty(exports, "initializeInAppMessaging", { enumerable: true, get: function () { return pinpoint_1.initializeInAppMessaging; } });
+Object.defineProperty(exports, "onMessageReceived", { enumerable: true, get: function () { return pinpoint_1.onMessageReceived; } });
+Object.defineProperty(exports, "onMessageDisplayed", { enumerable: true, get: function () { return pinpoint_1.onMessageDisplayed; } });
+Object.defineProperty(exports, "onMessageDismissed", { enumerable: true, get: function () { return pinpoint_1.onMessageDismissed; } });
+Object.defineProperty(exports, "onMessageActionTaken", { enumerable: true, get: function () { return pinpoint_1.onMessageActionTaken; } });
+Object.defineProperty(exports, "notifyMessageInteraction", { enumerable: true, get: function () { return pinpoint_1.notifyMessageInteraction; } });
+Object.defineProperty(exports, "clearMessages", { enumerable: true, get: function () { return pinpoint_1.clearMessages; } });

package/lib/inAppMessaging/providers/pinpoint/apis/clearMessages.d.ts

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

package/lib/inAppMessaging/providers/pinpoint/apis/clearMessages.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.clearMessages = void 0;
+const core_1 = require("@aws-amplify/core");
+const utils_1 = require("../utils");
+const utils_2 = require("../../../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();
+ *
+ * ```
+ */
+async function clearMessages() {
+    (0, utils_2.assertIsInitialized)();
+    const key = `${utils_1.PINPOINT_KEY_PREFIX}${utils_1.STORAGE_KEY_SUFFIX}`;
+    return await core_1.defaultStorage.removeItem(key);
+}
+exports.clearMessages = clearMessages;

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

@@ -0,0 +1,56 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dispatchEvent = void 0;
+const utils_1 = require("../utils");
+const flatten_1 = __importDefault(require("lodash/flatten"));
+const core_1 = require("@aws-amplify/core");
+const eventListeners_1 = require("../../../../eventListeners");
+const errors_1 = require("../../../errors");
+const setConflictHandler_1 = require("./setConflictHandler");
+const utils_2 = require("../../../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' });
+ * ```
+ */
+async function dispatchEvent(input) {
+    (0, utils_2.assertIsInitialized)();
+    try {
+        const key = `${utils_1.PINPOINT_KEY_PREFIX}${utils_1.STORAGE_KEY_SUFFIX}`;
+        const cachedMessages = await core_1.defaultStorage.getItem(key);
+        const messages = await (0, utils_1.processInAppMessages)(cachedMessages ? JSON.parse(cachedMessages) : [], input);
+        const flattenedMessages = (0, flatten_1.default)(messages);
+        if (flattenedMessages.length > 0) {
+            (0, eventListeners_1.notifyEventListeners)('messageReceived', (0, setConflictHandler_1.conflictHandler)(flattenedMessages));
+        }
+    }
+    catch (error) {
+        (0, errors_1.assertServiceError)(error);
+        throw error;
+    }
+}
+exports.dispatchEvent = dispatchEvent;

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

@@ -0,0 +1,79 @@
+"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.identifyUser = void 0;
+const utils_1 = require("@aws-amplify/core/internals/utils");
+const pinpoint_1 = require("@aws-amplify/core/internals/providers/pinpoint");
+const utils_2 = require("../utils");
+const utils_3 = require("../../../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']
+ *         },
+ *     },
+ * });
+ */
+const identifyUser = async ({ userId, userProfile, options, }) => {
+    (0, utils_3.assertIsInitialized)();
+    const { credentials, identityId } = await (0, utils_2.resolveCredentials)();
+    const { appId, region } = (0, utils_2.resolveConfig)();
+    const { address, optOut, userAttributes } = options ?? {};
+    (0, pinpoint_1.updateEndpoint)({
+        address,
+        channelType: utils_2.CHANNEL_TYPE,
+        optOut,
+        appId,
+        category: utils_2.CATEGORY,
+        credentials,
+        identityId,
+        region,
+        userAttributes,
+        userId,
+        userProfile,
+        userAgentValue: (0, utils_2.getInAppMessagingUserAgentString)(utils_1.InAppMessagingAction.IdentifyUser),
+    });
+};
+exports.identifyUser = identifyUser;

package/lib/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/inAppMessaging/providers/pinpoint/apis/index.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.clearMessages = exports.notifyMessageInteraction = exports.onMessageActionTaken = exports.onMessageDisplayed = exports.onMessageDismissed = exports.onMessageReceived = exports.initializeInAppMessaging = exports.setConflictHandler = exports.dispatchEvent = exports.syncMessages = exports.identifyUser = void 0;
+var identifyUser_1 = require("./identifyUser");
+Object.defineProperty(exports, "identifyUser", { enumerable: true, get: function () { return identifyUser_1.identifyUser; } });
+var syncMessages_1 = require("./syncMessages");
+Object.defineProperty(exports, "syncMessages", { enumerable: true, get: function () { return syncMessages_1.syncMessages; } });
+var dispatchEvent_1 = require("./dispatchEvent");
+Object.defineProperty(exports, "dispatchEvent", { enumerable: true, get: function () { return dispatchEvent_1.dispatchEvent; } });
+var setConflictHandler_1 = require("./setConflictHandler");
+Object.defineProperty(exports, "setConflictHandler", { enumerable: true, get: function () { return setConflictHandler_1.setConflictHandler; } });
+var initializeInAppMessaging_1 = require("./initializeInAppMessaging");
+Object.defineProperty(exports, "initializeInAppMessaging", { enumerable: true, get: function () { return initializeInAppMessaging_1.initializeInAppMessaging; } });
+var onMessageReceived_1 = require("./onMessageReceived");
+Object.defineProperty(exports, "onMessageReceived", { enumerable: true, get: function () { return onMessageReceived_1.onMessageReceived; } });
+var onMessageDismissed_1 = require("./onMessageDismissed");
+Object.defineProperty(exports, "onMessageDismissed", { enumerable: true, get: function () { return onMessageDismissed_1.onMessageDismissed; } });
+var onMessageDisplayed_1 = require("./onMessageDisplayed");
+Object.defineProperty(exports, "onMessageDisplayed", { enumerable: true, get: function () { return onMessageDisplayed_1.onMessageDisplayed; } });
+var onMessageActionTaken_1 = require("./onMessageActionTaken");
+Object.defineProperty(exports, "onMessageActionTaken", { enumerable: true, get: function () { return onMessageActionTaken_1.onMessageActionTaken; } });
+var notifyMessageInteraction_1 = require("./notifyMessageInteraction");
+Object.defineProperty(exports, "notifyMessageInteraction", { enumerable: true, get: function () { return notifyMessageInteraction_1.notifyMessageInteraction; } });
+var clearMessages_1 = require("./clearMessages");
+Object.defineProperty(exports, "clearMessages", { enumerable: true, get: function () { return clearMessages_1.clearMessages; } });

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

@@ -0,0 +1,57 @@
+"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.initializeInAppMessaging = void 0;
+const utils_1 = require("@aws-amplify/core/internals/utils");
+const eventListeners_1 = require("../../../../eventListeners");
+const helpers_1 = require("../utils/helpers");
+const types_1 = require("../types");
+const core_1 = require("@aws-amplify/core");
+const dispatchEvent_1 = require("./dispatchEvent");
+const utils_2 = require("../utils");
+const utils_3 = require("../../../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();
+ * ```
+ */
+function initializeInAppMessaging() {
+    if ((0, utils_3.isInitialized)()) {
+        return;
+    }
+    // register with the session listener
+    utils_1.sessionListener.addStateChangeListener(utils_2.sessionStateChangeHandler, true);
+    // wire up default Pinpoint message event handling
+    (0, eventListeners_1.addEventListener)('messageDisplayed', (message) => {
+        (0, helpers_1.recordAnalyticsEvent)(types_1.PinpointMessageEvent.MESSAGE_DISPLAYED, message);
+        (0, utils_2.incrementMessageCounts)(message.id);
+    });
+    (0, eventListeners_1.addEventListener)('messageDismissed', (message) => {
+        (0, helpers_1.recordAnalyticsEvent)(types_1.PinpointMessageEvent.MESSAGE_DISMISSED, message);
+    });
+    (0, eventListeners_1.addEventListener)('messageActionTaken', (message) => {
+        (0, helpers_1.recordAnalyticsEvent)(types_1.PinpointMessageEvent.MESSAGE_ACTION_TAKEN, message);
+    });
+    // listen to analytics hub events
+    core_1.Hub.listen('analytics', analyticsListener);
+    (0, utils_3.initialize)();
+}
+exports.initializeInAppMessaging = initializeInAppMessaging;
+function analyticsListener({ payload, }) {
+    const { event, data } = payload;
+    switch (event) {
+        case 'record': {
+            (0, dispatchEvent_1.dispatchEvent)(data);
+            break;
+        }
+        default:
+            break;
+    }
+}