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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/notifications",
-  "version": "2.0.1-api-v6-models.8035dfc.0+8035dfc",
+  "version": "2.0.1-api-v6-models.3eb7748.0+3eb7748",
   "description": "Notifications category of aws-amplify",
   "main": "./lib/index.js",
   "module": "./lib-esm/index.js",
@@ -14,11 +14,11 @@
     "test:default": "jest -w 1 --coverage",
     "test:native": "jest -w 1 --coverage --config=jest.native.config.js --coverageDirectory=coverage-native",
     "test:watch": "tslint 'src/**/*.ts' && jest -w 1 --watch",
-    "build-with-test": "npm run clean && npm test && tsc && webpack",
-    "build:cjs": "node ./build es5 && webpack && webpack --config ./webpack.config.dev.js",
-    "build:esm": "node ./build es6",
-    "build:cjs:watch": "node ./build es5 --watch",
-    "build:esm:watch": "node ./build es6 --watch",
+    "build-with-test": "npm run clean && npm test && tsc",
+    "build:cjs": "rimraf lib && tsc -p ./tsconfig.build.json -m commonjs --outDir lib",
+    "build:esm": "rimraf lib-esm && tsc -p ./tsconfig.build.json -m esnext --outDir lib-esm",
+    "build:cjs:watch": "rimraf lib && tsc -p ./tsconfig.build.json -m commonjs --outDir lib --watch",
+    "build:esm:watch": "rimraf lib-esm && tsc -p ./tsconfig.build.json -m esnext --outDir lib-esm --watch",
     "build": "npm run clean && npm run build:esm && npm run build:cjs",
     "clean": "npm run clean:size && rimraf lib-esm lib dist",
     "clean:size": "rimraf dual-publish-tmp tmp*",
@@ -57,9 +57,9 @@
       "require": "./lib/inAppMessaging/providers/index.js"
     },
     "./push-notifications": {
-      "types": "./lib-esm/pushNotifications/providers/index.d.ts",
-      "import": "./lib-esm/pushNotifications/providers/index.js",
-      "require": "./lib/pushNotifications/providers/index.js"
+      "types": "./lib-esm/pushNotifications/index.d.ts",
+      "import": "./lib-esm/pushNotifications/index.js",
+      "require": "./lib/pushNotifications/index.js"
     },
     "./in-app-messaging/pinpoint": {
       "types": "./lib-esm/inAppMessaging/providers/pinpoint/index.d.ts",
@@ -89,22 +89,23 @@
   "files": [
     "lib",
     "lib-esm",
-    "src"
+    "src",
+    "in-app-messaging",
+    "push-notifications"
   ],
   "dependencies": {
-    "lodash": "^4.17.21",
-    "uuid": "^9.0.0"
+    "lodash": "^4.17.21"
   },
   "peerDependencies": {
-    "@aws-amplify/core": "6.0.1-api-v6-models.8035dfc.0+8035dfc"
+    "@aws-amplify/core": "6.0.1-api-v6-models.3eb7748.0+3eb7748"
   },
   "devDependencies": {
-    "@aws-amplify/core": "6.0.1-api-v6-models.8035dfc.0+8035dfc",
+    "@aws-amplify/core": "6.0.1-api-v6-models.3eb7748.0+3eb7748",
     "@babel/core": "7.15.5",
     "@babel/plugin-proposal-class-properties": "^7.0.0",
     "@babel/plugin-proposal-private-methods": "^7.0.0",
     "@babel/plugin-proposal-private-property-in-object": "^7.0.0",
     "metro-react-native-babel-preset": "^0.66.2"
   },
-  "gitHead": "8035dfc20dda8f7b4d116616e89e72d889ceb5f1"
+  "gitHead": "3eb7748aee2fcdea705c93904d1f30ff596649fa"
 }

package/push-notifications/package.json

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

package/push-notifications/pinpoint/package.json

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

package/src/{common/eventListeners/index.ts → eventListeners/eventListeners.ts}

@@ -1,7 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { EventListener, EventType } from './types';
+import { EventListener, EventListenerRemover, EventType } from './types';
 
 const eventListeners: Record<string, Set<EventListener<Function>>> = {};
 
@@ -28,7 +28,7 @@ export const notifyEventListenersAndAwaitHandlers = (
 export const addEventListener = <EventHandler extends Function>(
 	type: EventType,
 	handler: EventHandler
-): EventListener<EventHandler> => {
+): EventListenerRemover => {
 	// If there is no listener set for the event type, just create it
 	if (!eventListeners[type]) {
 		eventListeners[type] = new Set<EventListener<EventHandler>>();
@@ -40,5 +40,7 @@ export const addEventListener = <EventHandler extends Function>(
 		},
 	};
 	eventListeners[type].add(listener);
-	return listener;
+	return {
+		remove: () => listener.remove(),
+	};
 };

package/src/{common → eventListeners}/index.ts

@@ -1,10 +1,9 @@
 // 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';
-export { EventListener, EventType } from './eventListeners/types';
+export { EventListener, EventType, EventListenerRemover } from './types';

package/src/{common/eventListeners → eventListeners}/types.ts

@@ -1,8 +1,8 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { InAppMessageInteractionEvent } from '../../inAppMessaging/types';
-import { PushNotificationEvent } from '../../pushNotifications/types';
+import { InAppMessageInteractionEvent } from '../inAppMessaging/types';
+import { PushNotificationEvent } from '../pushNotifications/types';
 
 export interface EventListener<EventHandler extends Function> {
 	handleEvent: EventHandler;
@@ -10,3 +10,7 @@ export interface EventListener<EventHandler extends Function> {
 }
 
 export type EventType = InAppMessageInteractionEvent | PushNotificationEvent;
+
+export type EventListenerRemover = {
+	remove: () => void;
+};

package/src/inAppMessaging/errors/validation.ts

@@ -7,7 +7,7 @@ export enum InAppMessagingValidationErrorCode {
 	NoAppId = 'NoAppId',
 	NoCredentials = 'NoCredentials',
 	NoRegion = 'NoRegion',
-	NoEndpointId = 'NoEndpointId',
+	NotInitialized = 'NotInitialized',
 }
 
 export const validationErrorMap: AmplifyErrorMap<InAppMessagingValidationErrorCode> =
@@ -21,7 +21,9 @@ export const validationErrorMap: AmplifyErrorMap<InAppMessagingValidationErrorCo
 		[InAppMessagingValidationErrorCode.NoRegion]: {
 			message: 'Missing region.',
 		},
-		[InAppMessagingValidationErrorCode.NoEndpointId]: {
-			message: 'Could not find or create EndpointId.',
+		[InAppMessagingValidationErrorCode.NotInitialized]: {
+			message: 'In-app messaging has not been initialized.',
+			recoverySuggestion:
+				'Please make sure to first call `initializePushNotifications`.',
 		},
 	};

package/src/inAppMessaging/index.ts

@@ -6,4 +6,22 @@ export {
 	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/src/inAppMessaging/providers/index.ts

@@ -6,4 +6,33 @@ export {
 	syncMessages,
 	dispatchEvent,
 	setConflictHandler,
-} from './pinpoint/apis';
+	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/src/inAppMessaging/providers/pinpoint/apis/dispatchEvent.ts

@@ -9,34 +9,39 @@ import {
 import { InAppMessage } from '../../../types';
 import flatten from 'lodash/flatten';
 import { defaultStorage } from '@aws-amplify/core';
-import { notifyEventListeners } from '../../../../common';
+import { notifyEventListeners } from '../../../../eventListeners';
 import { assertServiceError } from '../../../errors';
 import { DispatchEventInput } from '../types';
 import { syncMessages } from './syncMessages';
 import { conflictHandler, setConflictHandler } 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 async function dispatchEvent(input: DispatchEventInput): Promise<void> {
+	assertIsInitialized();
 	try {
 		const key = `${PINPOINT_KEY_PREFIX}${STORAGE_KEY_SUFFIX}`;
 		const cachedMessages = await defaultStorage.getItem(key);
@@ -45,7 +50,6 @@ export async function dispatchEvent(input: DispatchEventInput): Promise<void> {
 			input
 		);
 		const flattenedMessages = flatten(messages);
-
 		if (flattenedMessages.length > 0) {
 			notifyEventListeners(
 				'messageReceived',

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

@@ -2,7 +2,10 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { InAppMessagingAction } from '@aws-amplify/core/internals/utils';
-import { updateEndpoint } from '@aws-amplify/core/internals/providers/pinpoint';
+import {
+	updateEndpoint,
+	UpdateEndpointException,
+} from '@aws-amplify/core/internals/providers/pinpoint';
 import { InAppMessagingValidationErrorCode } from '../../../errors';
 import {
 	CATEGORY,
@@ -12,6 +15,7 @@ import {
 	resolveCredentials,
 } from '../utils';
 import { IdentifyUserInput } from '../types';
+import { assertIsInitialized } from '../../../utils';
 
 /**
  * Sends information about a user to Pinpoint. Sending user information allows you to associate a user to their user
@@ -20,13 +24,10 @@ import { IdentifyUserInput } from '../types';
  *
  * @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
@@ -57,12 +58,10 @@ import { IdentifyUserInput } from '../types';
  *         }
  *     },
  *     options: {
- *         serviceOptions: {
- *             address: 'device-address',
- *             optOut: 'NONE',
- * 			   userAttributes: {
- * 			      interests: ['food']
- * 			   },
+ *         address: 'device-address',
+ *         optOut: 'NONE',
+ *         userAttributes: {
+ *             interests: ['food']
  *         },
  *     },
  * });
@@ -72,9 +71,10 @@ export const identifyUser = async ({
 	userProfile,
 	options,
 }: IdentifyUserInput): Promise<void> => {
+	assertIsInitialized();
 	const { credentials, identityId } = await resolveCredentials();
 	const { appId, region } = resolveConfig();
-	const { address, optOut, userAttributes } = options?.serviceOptions ?? {};
+	const { address, optOut, userAttributes } = options ?? {};
 	updateEndpoint({
 		address,
 		channelType: CHANNEL_TYPE,

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

@@ -5,3 +5,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/src/inAppMessaging/providers/pinpoint/apis/initializeInAppMessaging.ts

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

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

@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { InAppMessage } from '../../../types';
+import { assertIsInitialized } from '../../../utils';
 import { InAppMessageConflictHandler, SetConflictHandlerInput } from '../types';
 
 export let conflictHandler: InAppMessageConflictHandler =
@@ -10,13 +11,13 @@ export 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 between sessions
- * and needs to be called before dispatching an event to have any effect.
  *
+ * @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
@@ -33,10 +34,11 @@ export let conflictHandler: InAppMessageConflictHandler =
  * setConflictHandler(myConflictHandler);
  *
  * // Dispatch an event
- * await dispatchEvent({ name: "test_event" });
+ * await dispatchEvent({ name: 'test_event' });
  * ```
  */
 export function setConflictHandler(input: SetConflictHandlerInput): void {
+	assertIsInitialized();
 	conflictHandler = input;
 }