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

package/src/inAppMessaging/providers/pinpoint/apis/notifyMessageInteraction.ts

@@ -0,0 +1,28 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { notifyEventListeners } from '../../../../eventListeners';
+import { assertIsInitialized } from '../../../utils';
+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 function notifyMessageInteraction({
+	type,
+	message,
+}: NotifyMessageInteractionInput): void {
+	assertIsInitialized();
+	notifyEventListeners(type, message);
+}

package/src/inAppMessaging/providers/pinpoint/apis/onMessageActionTaken.ts

@@ -0,0 +1,29 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { addEventListener } from '../../../../eventListeners';
+import { assertIsInitialized } from '../../../utils';
+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 function onMessageActionTaken(
+	input: OnMessageActionTakenInput
+): OnMessageActionTakenOutput {
+	assertIsInitialized();
+	return addEventListener('messageActionTaken', input);
+}

package/src/inAppMessaging/providers/pinpoint/apis/onMessageDismissed.ts

@@ -0,0 +1,29 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { addEventListener } from '../../../../eventListeners';
+import { OnMessageDismissedOutput } from '../types/outputs';
+import { OnMessageDismissedInput } from '../types/inputs';
+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: OnMessageDismissedInput
+): OnMessageDismissedOutput {
+	assertIsInitialized();
+	return addEventListener('messageDismissed', input);
+}

package/src/inAppMessaging/providers/pinpoint/apis/onMessageDisplayed.ts

@@ -0,0 +1,29 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { addEventListener } from '../../../../eventListeners';
+import { OnMessageDisplayedOutput } from '../types/outputs';
+import { OnMessageDisplayedInput } from '../types/inputs';
+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: OnMessageDisplayedInput
+): OnMessageDisplayedOutput {
+	assertIsInitialized();
+	return addEventListener('messageDisplayed', input);
+}

package/src/inAppMessaging/providers/pinpoint/apis/onMessageReceived.ts

@@ -0,0 +1,29 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { addEventListener } from '../../../../eventListeners';
+import { assertIsInitialized } from '../../../utils';
+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 function onMessageReceived(
+	input: OnMessageReceivedInput
+): OnMessageReceivedOutput {
+	assertIsInitialized();
+	return addEventListener('messageReceived', input);
+}

package/src/inAppMessaging/providers/pinpoint/apis/setConflictHandler.ts

@@ -0,0 +1,68 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { InAppMessage } from '../../../types';
+import { assertIsInitialized } from '../../../utils';
+import { InAppMessageConflictHandler, SetConflictHandlerInput } from '../types';
+
+export let conflictHandler: InAppMessageConflictHandler =
+	defaultConflictHandler;
+
+/**
+ * Set a conflict handler that will be used to resolve conflicts that may emerge
+ * when matching events with synced messages.
+ *
+ * @remark
+ * The conflict handler is not persisted across app restarts and so must be set again before dispatching an event for
+ * any custom handling to take effect.
+ * @throws validation: {@link InAppMessagingValidationErrorCode} - Thrown when the provided parameters or library
+ * configuration is incorrect, or if In App messaging hasn't been initialized.
+ * @param SetConflictHandlerInput: The input object that holds the conflict handler to be used.
+ * @example
+ * ```ts
+ * // Sync messages before dispatching an event
+ * await syncMessages();
+ *
+ * // Example custom conflict handler
+ * const myConflictHandler = (messages) => {
+ * 		// Return a random message
+ * 		const randomIndex = Math.floor(Math.random() * messages.length);
+ * 		return messages[randomIndex];
+ *  };
+ *
+ * // Set the conflict handler
+ * setConflictHandler(myConflictHandler);
+ *
+ * // Dispatch an event
+ * await dispatchEvent({ name: 'test_event' });
+ * ```
+ */
+export function setConflictHandler(input: SetConflictHandlerInput): void {
+	assertIsInitialized();
+	conflictHandler = input;
+}
+
+function defaultConflictHandler(messages: InAppMessage[]): InAppMessage {
+	// 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/src/inAppMessaging/providers/pinpoint/apis/syncMessages.ts

@@ -0,0 +1,88 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { InAppMessagingAction } from '@aws-amplify/core/internals/utils';
+import { resolveEndpointId } from '@aws-amplify/core/internals/providers/pinpoint';
+import { defaultStorage } from '@aws-amplify/core';
+import {
+	resolveConfig,
+	resolveCredentials,
+	getInAppMessagingUserAgentString,
+	STORAGE_KEY_SUFFIX,
+	PINPOINT_KEY_PREFIX,
+	CATEGORY,
+	CHANNEL_TYPE,
+} from '../utils';
+import {
+	getInAppMessages,
+	GetInAppMessagesInput,
+	GetInAppMessagesOutput,
+} from '@aws-amplify/core/internals/aws-clients/pinpoint';
+import {
+	InAppMessagingValidationErrorCode,
+	assertServiceError,
+} from '../../../errors';
+import { assertIsInitialized } from '../../../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();
+ *
+ * ```
+ */
+export async function syncMessages(): Promise<void> {
+	assertIsInitialized();
+	const messages = await fetchInAppMessages();
+	if (!messages || messages.length === 0) {
+		return;
+	}
+	try {
+		const key = `${PINPOINT_KEY_PREFIX}${STORAGE_KEY_SUFFIX}`;
+		await defaultStorage.setItem(key, JSON.stringify(messages));
+	} catch (error) {
+		assertServiceError(error);
+		throw error;
+	}
+}
+
+async function fetchInAppMessages() {
+	try {
+		const { credentials, identityId } = await resolveCredentials();
+		const { appId, region } = resolveConfig();
+		const endpointId = await resolveEndpointId({
+			appId,
+			category: CATEGORY,
+			channelType: CHANNEL_TYPE,
+			credentials,
+			identityId,
+			region,
+			userAgentValue: getInAppMessagingUserAgentString(
+				InAppMessagingAction.SyncMessages
+			),
+		});
+
+		const input: GetInAppMessagesInput = {
+			ApplicationId: appId,
+			EndpointId: endpointId,
+		};
+		const response: GetInAppMessagesOutput = await getInAppMessages(
+			{ credentials, region },
+			input
+		);
+		const { InAppMessageCampaigns: messages } =
+			response.InAppMessagesResponse ?? {};
+		return messages;
+	} catch (error) {
+		assertServiceError(error);
+		throw error;
+	}
+}

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

@@ -0,0 +1,31 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+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/src/inAppMessaging/providers/pinpoint/types/index.ts

@@ -0,0 +1,29 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+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/src/inAppMessaging/providers/pinpoint/types/inputs.ts

@@ -0,0 +1,58 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+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/src/inAppMessaging/providers/pinpoint/types/options.ts

@@ -0,0 +1,9 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { PinpointServiceOptions } from '@aws-amplify/core/internals/providers/pinpoint';
+
+/**
+ * Options specific to Pinpoint identityUser.
+ */
+export type IdentifyUserOptions = PinpointServiceOptions;

package/src/inAppMessaging/providers/pinpoint/types/outputs.ts

@@ -0,0 +1,24 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+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/src/{InAppMessaging/Providers/AWSPinpointProvider → inAppMessaging/providers/pinpoint/types}/types.ts

@@ -1,6 +1,8 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+import { InAppMessage } from '../../../types';
+
 export type InAppMessageCountMap = Record<string, number>;
 
 export type DailyInAppMessageCounter = {
@@ -19,8 +21,14 @@ export type MetricsComparator = (
 	eventVal: number
 ) => boolean;
 
-export enum AWSPinpointMessageEvent {
+export 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/src/inAppMessaging/providers/pinpoint/utils/constants.ts

@@ -0,0 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export const PINPOINT_KEY_PREFIX = 'Pinpoint';
+export const STORAGE_KEY_SUFFIX = '_inAppMessages';
+export const CATEGORY = 'InAppMessaging';
+export const CHANNEL_TYPE = 'IN_APP';