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

package/src/pushNotifications/providers/pinpoint/apis/onNotificationOpened.ts

@@ -0,0 +1,39 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { PlatformNotSupportedError } from '@aws-amplify/core/internals/utils';
+import { PushNotificationMessage } from '../../../types';
+import {
+	OnNotificationOpened,
+	OnNotificationOpenedInput,
+	OnNotificationOpenedOutput,
+} from '../types';
+
+/**
+ * Registers a listener that will be triggered when a notification is opened by user.
+ *
+ * @param {OnNotificationOpenedInput} input - A callback handler to be invoked with the opened
+ * {@link PushNotificationMessage}.
+ * @returns {OnNotificationOpenedOutput} - An object with a remove function to remove the listener.
+ * @example
+ * ```ts
+ * // Register a listener
+ * onNotificationOpened(message => {
+ *   doSomething(message);
+ * });
+ * ```
+ * @example
+ * ```ts
+ * // Register multiple listeners
+ * onNotificationOpened(message => {
+ *   doSomething(message);
+ * });
+ *
+ * onNotificationOpened(message => {
+ *   doSomethingElse(message);
+ * });
+ * ```
+ */
+export const onNotificationOpened: OnNotificationOpened = () => {
+	throw new PlatformNotSupportedError();
+};

package/src/pushNotifications/providers/pinpoint/apis/onNotificationReceivedInBackground.native.ts

@@ -0,0 +1,12 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { addEventListener } from '../../../../eventListeners';
+import { assertIsInitialized } from '../../../errors/errorHelpers';
+import { OnNotificationReceivedInBackground } from '../types';
+
+export const onNotificationReceivedInBackground: OnNotificationReceivedInBackground =
+	input => {
+		assertIsInitialized();
+		return addEventListener('backgroundMessageReceived', input);
+	};

package/src/pushNotifications/providers/pinpoint/apis/onNotificationReceivedInBackground.ts

@@ -0,0 +1,56 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { PlatformNotSupportedError } from '@aws-amplify/core/internals/utils';
+import { PushNotificationMessage } from '../../../types';
+import {
+	OnNotificationReceivedInBackground,
+	OnNotificationReceivedInBackgroundInput,
+	OnNotificationReceivedInBackgroundOutput,
+} from '../types';
+
+/**
+ * Registers a listener that will be triggered when a notification is received while app is in a background state.
+ *
+ * @throws platform: {@link PlatformNotSupportedError} - Thrown if called against an unsupported platform. Currently,
+ * only React Native is supported by this API.
+ * @param {OnNotificationReceivedInBackgroundInput} input - A callback handler to be invoked with the received
+ * {@link PushNotificationMessage}.
+ * @returns {OnNotificationReceivedInBackgroundOutput} - An object with a remove function to remove the listener.
+ * @remarks Notifications received while app is in a quit state will start the app (as a headless JS instance running
+ * on a background service on Android) in the background. Handlers registered via this function should return promises
+ * if it needs to be asynchronous (e.g. to perform some network requests). The app should run in the background as long
+ * as there are handlers still running (however, if they run for more than 30 seconds on iOS, subsequent tasks could
+ * get deprioritized!). If it is necessary for a handler to execute while the app is in quit state, it should be
+ * registered in the application entry point (e.g. index.js) since the application will not fully mount in that case.
+ * @example
+ * ```ts
+ * // Register a listener
+ * onNotificationReceivedInBackground(message => {
+ *   doSomething(message);
+ * });
+ * ```
+ * @example
+ * ```ts
+ * // Register multiple listeners
+ * onNotificationReceivedInBackground(message => {
+ *   doSomething(message);
+ * });
+ *
+ * onNotificationReceivedInBackground(message => {
+ *   doSomethingElse(message);
+ * });
+ * ```
+ * @example
+ * ```ts
+ * // Register async listener
+ * onNotificationReceivedInBackground(async message => {
+ *   await doSomething(message);
+ *   console.log(`did something with ${message}`);
+ * });
+ * ```
+ */
+export const onNotificationReceivedInBackground: OnNotificationReceivedInBackground =
+	() => {
+		throw new PlatformNotSupportedError();
+	};

package/src/pushNotifications/providers/pinpoint/apis/onNotificationReceivedInForeground.native.ts

@@ -0,0 +1,12 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { addEventListener } from '../../../../eventListeners';
+import { assertIsInitialized } from '../../../errors/errorHelpers';
+import { OnNotificationReceivedInForeground } from '../types';
+
+export const onNotificationReceivedInForeground: OnNotificationReceivedInForeground =
+	input => {
+		assertIsInitialized();
+		return addEventListener('foregroundMessageReceived', input);
+	};

package/src/pushNotifications/providers/pinpoint/apis/onNotificationReceivedInForeground.ts

@@ -0,0 +1,40 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { PlatformNotSupportedError } from '@aws-amplify/core/internals/utils';
+import { PushNotificationMessage } from '../../../types';
+import {
+	OnNotificationReceivedInForeground,
+	OnNotificationReceivedInForegroundInput,
+	OnNotificationReceivedInForegroundOutput,
+} from '../types';
+
+/**
+ * Registers a listener that will be triggered when a notification is received while app is in a foreground state.
+ *
+ * @param {OnNotificationReceivedInForegroundInput} input - A callback handler to be invoked with the received
+ * {@link PushNotificationMessage}.
+ * @returns {OnNotificationReceivedInForegroundOutput} - An object with a remove function to remove the listener.
+ * @example
+ * ```ts
+ * // Register a listener
+ * onNotificationReceivedInForeground(message => {
+ *   doSomething(message);
+ * });
+ * ```
+ * @example
+ * ```ts
+ * // Register multiple listeners
+ * onNotificationReceivedInForeground(message => {
+ *   doSomething(message);
+ * });
+ *
+ * onNotificationReceivedInForeground(message => {
+ *   doSomethingElse(message);
+ * });
+ * ```
+ */
+export const onNotificationReceivedInForeground: OnNotificationReceivedInForeground =
+	() => {
+		throw new PlatformNotSupportedError();
+	};

package/src/pushNotifications/providers/pinpoint/apis/onTokenReceived.native.ts

@@ -0,0 +1,11 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { addEventListener } from '../../../../eventListeners';
+import { assertIsInitialized } from '../../../errors/errorHelpers';
+import { OnTokenReceived } from '../types';
+
+export const onTokenReceived: OnTokenReceived = input => {
+	assertIsInitialized();
+	return addEventListener('tokenReceived', input);
+};

package/src/pushNotifications/providers/pinpoint/apis/onTokenReceived.ts

@@ -0,0 +1,39 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { PlatformNotSupportedError } from '@aws-amplify/core/internals/utils';
+import {
+	OnTokenReceived,
+	OnTokenReceivedInput,
+	OnTokenReceivedOutput,
+} from '../types';
+
+/**
+ * Registers a listener that will be triggered when a token is received. A token will be received:
+ *   1. On every app launch, including the first install
+ *   2. When a token changes (this may happen if the service invalidates the token for any reason)
+ *
+ * @param {OnTokenReceivedInput} input - A callback handler to be invoked with the token.
+ * @returns {OnTokenReceivedOutput} - An object with a remove function to remove the listener.
+ * @example
+ * ```ts
+ * // Register a listener
+ * onTokenReceived(message => {
+ *   doSomething(message);
+ * });
+ * ```
+ * @example
+ * ```ts
+ * // Register multiple listeners
+ * onTokenReceived(message => {
+ *   doSomething(message);
+ * });
+ *
+ * onTokenReceived(message => {
+ *   doSomethingElse(message);
+ * });
+ * ```
+ */
+export const onTokenReceived: OnTokenReceived = () => {
+	throw new PlatformNotSupportedError();
+};

package/src/pushNotifications/providers/pinpoint/apis/requestPermissions.native.ts

@@ -0,0 +1,14 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { loadAmplifyPushNotification } from '@aws-amplify/react-native';
+import { assertIsInitialized } from '../../../errors/errorHelpers';
+import { RequestPermissions } from '../types';
+
+const { requestPermissions: requestPermissionsNative } =
+	loadAmplifyPushNotification();
+
+export const requestPermissions: RequestPermissions = async input => {
+	assertIsInitialized();
+	return requestPermissionsNative(input);
+};

package/src/pushNotifications/providers/pinpoint/apis/requestPermissions.ts

@@ -0,0 +1,39 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { PlatformNotSupportedError } from '@aws-amplify/core/internals/utils';
+import { RequestPermissions } from '../types';
+
+/**
+ * Requests notification permissions from your user. By default, Amplify requests all supported permissions but you can
+ * choose not to request specific permissions. The resulting promise will resolve to true if requested permissions are
+ * granted (or have previously been granted) or false otherwise. Not all specific permissions are supported by platforms
+ * your React Native app can run on but will be safely ignored even on those platforms. Currently supported permissions:
+ *
+ *   * `alert`: When set to true, requests the ability to display notifications to the user.
+ *
+ *   * `sound`: When set to true, requests the ability to play a sound in response to notifications.
+ *
+ *   * `badge`: When set to true, requests the ability to update the app's badge.
+ *
+ * @throws platform: {@link PlatformNotSupportedError} - Thrown if called against an unsupported platform. Currently,
+ * only React Native is supported by this API.
+ * @returns A promise that resolves to true if requested permissions are granted or have already previously been
+ * granted or false otherwise.
+ * @example
+ * ```ts
+ * // Request all permissions by default
+ * const arePermissionsGranted = await requestPermissions();
+ *
+ * @example
+ * ```ts
+ * // Prevent requesting specific permissions
+ * const arePermissionsGranted = await requestPermissions({
+ *   sound: false,
+ *   badge: false
+ * });
+ * ```
+ */
+export const requestPermissions: RequestPermissions = async () => {
+	throw new PlatformNotSupportedError();
+};

package/src/pushNotifications/providers/pinpoint/apis/setBadgeCount.native.ts

@@ -0,0 +1,13 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { loadAmplifyPushNotification } from '@aws-amplify/react-native';
+import { assertIsInitialized } from '../../../errors/errorHelpers';
+import { SetBadgeCount } from '../types';
+
+const { setBadgeCount: setBadgeCountNative } = loadAmplifyPushNotification();
+
+export const setBadgeCount: SetBadgeCount = input => {
+	assertIsInitialized();
+	setBadgeCountNative(input);
+};

package/src/pushNotifications/providers/pinpoint/apis/setBadgeCount.ts

@@ -0,0 +1,21 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { PlatformNotSupportedError } from '@aws-amplify/core/internals/utils';
+import { SetBadgeCount } from '../types';
+
+/**
+ * Sets the current badge count (the number on the top right corner of your app's icon). Setting the badge count
+ * to 0 (zero) will remove the badge from your app's icon. This function is safe to call (but will be ignored) even
+ * when your React Native app is running on platforms where badges are not supported.
+ *
+ * @throws platform: {@link PlatformNotSupportedError} - Thrown if called against an unsupported platform. Currently,
+ * only React Native is supported by this API.
+ * @example
+ * ```ts
+ * setBadgeCount(42);
+ * ```
+ */
+export const setBadgeCount: SetBadgeCount = () => {
+	throw new PlatformNotSupportedError();
+};

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

@@ -0,0 +1,34 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export {
+	getBadgeCount,
+	getLaunchNotification,
+	getPermissionStatus,
+	identifyUser,
+	initializePushNotifications,
+	onNotificationOpened,
+	onNotificationReceivedInBackground,
+	onNotificationReceivedInForeground,
+	onTokenReceived,
+	requestPermissions,
+	setBadgeCount,
+} from './apis';
+export {
+	IdentifyUserInput,
+	OnNotificationOpenedInput,
+	OnNotificationReceivedInBackgroundInput,
+	OnNotificationReceivedInForegroundInput,
+	OnTokenReceivedInput,
+	RequestPermissionsInput,
+	SetBadgeCountInput,
+} from './types/inputs';
+export {
+	GetBadgeCountOutput,
+	GetLaunchNotificationOutput,
+	GetPermissionStatusOutput,
+	OnNotificationOpenedOutput,
+	OnNotificationReceivedInBackgroundOutput,
+	OnNotificationReceivedInForegroundOutput,
+	OnTokenReceivedOutput,
+} from './types/outputs';

package/src/pushNotifications/providers/pinpoint/types/analytics.ts

@@ -0,0 +1,14 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export type PinpointMessageEvent =
+	| 'opened_notification'
+	| 'received_background'
+	| 'received_foreground';
+
+export type PinpointMessageEventSource = '_campaign' | '_journey';
+
+export type AnalyticsEventAttributes = {
+	source: PinpointMessageEventSource;
+	attributes: Record<string, string>;
+};

package/src/pushNotifications/providers/pinpoint/types/apis.ts

@@ -0,0 +1,54 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	IdentifyUserInput,
+	OnNotificationOpenedInput,
+	OnNotificationReceivedInBackgroundInput,
+	OnNotificationReceivedInForegroundInput,
+	OnTokenReceivedInput,
+	RequestPermissionsInput,
+	SetBadgeCountInput,
+} from './inputs';
+import {
+	GetBadgeCountOutput,
+	GetLaunchNotificationOutput,
+	GetPermissionStatusOutput,
+	OnNotificationOpenedOutput,
+	OnNotificationReceivedInBackgroundOutput,
+	OnNotificationReceivedInForegroundOutput,
+	OnTokenReceivedOutput,
+	RequestPermissionsOutput,
+} from './outputs';
+
+export type GetBadgeCount = () => Promise<void | GetBadgeCountOutput>;
+
+export type GetLaunchNotification = () => Promise<GetLaunchNotificationOutput>;
+
+export type GetPermissionStatus = () => Promise<GetPermissionStatusOutput>;
+
+export type IdentifyUser = (input: IdentifyUserInput) => Promise<void>;
+
+export type InitializePushNotifications = () => void;
+
+export type RequestPermissions = (
+	input?: RequestPermissionsInput
+) => Promise<RequestPermissionsOutput>;
+
+export type SetBadgeCount = (input: SetBadgeCountInput) => void;
+
+export type OnNotificationOpened = (
+	input: OnNotificationOpenedInput
+) => OnNotificationOpenedOutput;
+
+export type OnNotificationReceivedInBackground = (
+	input: OnNotificationReceivedInBackgroundInput
+) => OnNotificationReceivedInBackgroundOutput;
+
+export type OnNotificationReceivedInForeground = (
+	input: OnNotificationReceivedInForegroundInput
+) => OnNotificationReceivedInForegroundOutput;
+
+export type OnTokenReceived = (
+	input: OnTokenReceivedInput
+) => OnTokenReceivedOutput;

package/src/pushNotifications/providers/pinpoint/types/index.ts

@@ -0,0 +1,40 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export {
+	AnalyticsEventAttributes,
+	PinpointMessageEvent,
+	PinpointMessageEventSource,
+} from './analytics';
+export {
+	GetBadgeCount,
+	GetLaunchNotification,
+	GetPermissionStatus,
+	IdentifyUser,
+	InitializePushNotifications,
+	OnNotificationOpened,
+	OnNotificationReceivedInBackground,
+	OnNotificationReceivedInForeground,
+	OnTokenReceived,
+	RequestPermissions,
+	SetBadgeCount,
+} from './apis';
+export {
+	IdentifyUserInput,
+	OnNotificationOpenedInput,
+	OnNotificationReceivedInBackgroundInput,
+	OnNotificationReceivedInForegroundInput,
+	OnTokenReceivedInput,
+	RequestPermissionsInput,
+	SetBadgeCountInput,
+} from './inputs';
+export {
+	GetLaunchNotificationOutput,
+	GetPermissionStatusOutput,
+	OnNotificationOpenedOutput,
+	OnNotificationReceivedInBackgroundOutput,
+	OnNotificationReceivedInForegroundOutput,
+	OnTokenReceivedOutput,
+} from './outputs';
+export { IdentifyUserOptions } from './options';
+export { ChannelType } from './pushNotifications';

package/src/pushNotifications/providers/pinpoint/types/inputs.ts

@@ -0,0 +1,31 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { IdentifyUserOptions } from './options';
+import {
+	PushNotificationIdentifyUserInput,
+	PushNotificationRequestPermissionsInput,
+	PushNotificationSetBadgeCountInput,
+	PushNotificationOnNotificationOpenedInput,
+	PushNotificationOnNotificationReceivedInBackgroundInput,
+	PushNotificationOnNotificationReceivedInForegroundInput,
+	PushNotificationOnTokenReceivedInput,
+} from '../../../types';
+
+export type IdentifyUserInput =
+	PushNotificationIdentifyUserInput<IdentifyUserOptions>;
+
+export type RequestPermissionsInput = PushNotificationRequestPermissionsInput;
+
+export type SetBadgeCountInput = PushNotificationSetBadgeCountInput;
+
+export type OnNotificationOpenedInput =
+	PushNotificationOnNotificationOpenedInput;
+
+export type OnNotificationReceivedInBackgroundInput =
+	PushNotificationOnNotificationReceivedInBackgroundInput;
+
+export type OnNotificationReceivedInForegroundInput =
+	PushNotificationOnNotificationReceivedInForegroundInput;
+
+export type OnTokenReceivedInput = PushNotificationOnTokenReceivedInput;

package/src/pushNotifications/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/pushNotifications/providers/pinpoint/types/outputs.ts

@@ -0,0 +1,34 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	PushNotificationGetBadgeCountOutput,
+	PushNotificationGetLaunchNotificationOutput,
+	PushNotificationGetPermissionStatusOutput,
+	PushNotificationOnNotificationOpenedOutput,
+	PushNotificationOnNotificationReceivedInBackgroundOutput,
+	PushNotificationOnNotificationReceivedInForegroundOutput,
+	PushNotificationOnTokenReceivedOutput,
+	PushNotificationRequestPermissionsOutput,
+} from '../../../types';
+
+export type GetBadgeCountOutput = PushNotificationGetBadgeCountOutput;
+
+export type GetLaunchNotificationOutput =
+	PushNotificationGetLaunchNotificationOutput;
+
+export type GetPermissionStatusOutput =
+	PushNotificationGetPermissionStatusOutput;
+
+export type RequestPermissionsOutput = PushNotificationRequestPermissionsOutput;
+
+export type OnNotificationOpenedOutput =
+	PushNotificationOnNotificationOpenedOutput;
+
+export type OnNotificationReceivedInBackgroundOutput =
+	PushNotificationOnNotificationReceivedInBackgroundOutput;
+
+export type OnNotificationReceivedInForegroundOutput =
+	PushNotificationOnNotificationReceivedInForegroundOutput;
+
+export type OnTokenReceivedOutput = PushNotificationOnTokenReceivedOutput;

package/src/pushNotifications/providers/pinpoint/types/pushNotifications.ts

@@ -0,0 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { updateEndpoint } from '@aws-amplify/core/internals/providers/pinpoint';
+
+export type ChannelType = Parameters<typeof updateEndpoint>[0]['channelType'];

package/src/pushNotifications/providers/pinpoint/utils/createMessageEventRecorder.ts

@@ -0,0 +1,66 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { record } from '@aws-amplify/core/internals/providers/pinpoint';
+import { ConsoleLogger } from '@aws-amplify/core';
+import { AWSCredentials } from '@aws-amplify/core/internals/utils';
+import { PinpointMessageEvent } from '../types';
+import {
+	OnPushNotificationMessageHandler,
+	PushNotificationMessage,
+} from '../../../types';
+import { resolveCredentials } from '../../../utils';
+import { getAnalyticsEvent } from './getAnalyticsEvent';
+import { getChannelType } from './getChannelType';
+import { resolveConfig } from './resolveConfig';
+
+const logger = new ConsoleLogger('PushNotification.recordMessageEvent');
+
+/**
+ * @internal
+ */
+export const createMessageEventRecorder =
+	(
+		event: PinpointMessageEvent,
+		callback?: Function
+	): OnPushNotificationMessageHandler =>
+	async message => {
+		const { credentials } = await resolveCredentials();
+		const { appId, region } = resolveConfig();
+		await recordMessageEvent({
+			appId,
+			credentials,
+			event,
+			message,
+			region,
+		});
+		callback?.();
+	};
+
+const recordMessageEvent = async ({
+	appId,
+	credentials,
+	event,
+	message,
+	region,
+}: {
+	appId: string;
+	credentials: AWSCredentials;
+	event: PinpointMessageEvent;
+	message: PushNotificationMessage;
+	region: string;
+}): Promise<void> => {
+	const analyticsEvent = getAnalyticsEvent(message, event);
+	if (!analyticsEvent) {
+		logger.debug('A notification missing event information was not recorded');
+		return;
+	}
+	return record({
+		appId,
+		category: 'PushNotification',
+		channelType: getChannelType(),
+		credentials,
+		event: analyticsEvent,
+		region,
+	});
+};

package/src/pushNotifications/providers/pinpoint/utils/getAnalyticsEvent.ts

@@ -0,0 +1,66 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { PinpointAnalyticsEvent } from '@aws-amplify/core/internals/providers/pinpoint';
+import { AnalyticsEventAttributes, PinpointMessageEvent } from '../types';
+import { PushNotificationMessage } from '../../../types';
+
+const ANDROID_CAMPAIGN_ACTIVITY_ID_KEY =
+	'pinpoint.campaign.campaign_activity_id';
+const ANDROID_CAMPAIGN_ID_KEY = 'pinpoint.campaign.campaign_id';
+const ANDROID_CAMPAIGN_TREATMENT_ID_KEY = 'pinpoint.campaign.treatment_id';
+
+/**
+ * @internal
+ */
+export const getAnalyticsEvent = (
+	{ data }: PushNotificationMessage,
+	event: PinpointMessageEvent
+): PinpointAnalyticsEvent | null => {
+	if (!data) {
+		return null;
+	}
+	const eventAttributes = getAnalyticsEventAttributes(data);
+	if (!eventAttributes) {
+		return null;
+	}
+	const { source, attributes } = eventAttributes;
+	return {
+		attributes,
+		name: `${source}.${event}`,
+	};
+};
+
+const getAnalyticsEventAttributes = (
+	data: PushNotificationMessage['data']
+): AnalyticsEventAttributes | undefined => {
+	if (!data) {
+		return;
+	}
+	if (data.hasOwnProperty(ANDROID_CAMPAIGN_ID_KEY)) {
+		return {
+			source: '_campaign',
+			attributes: {
+				campaign_activity_id: data[ANDROID_CAMPAIGN_ACTIVITY_ID_KEY] as string,
+				campaign_id: data[ANDROID_CAMPAIGN_ID_KEY] as string,
+				treatment_id: data[ANDROID_CAMPAIGN_TREATMENT_ID_KEY] as string,
+			},
+		};
+	}
+	const pinpoint =
+		typeof data.pinpoint === 'string'
+			? JSON.parse(data.pinpoint)
+			: data.pinpoint;
+	if (pinpoint?.campaign) {
+		return {
+			source: '_campaign',
+			attributes: pinpoint.campaign,
+		};
+	}
+	if (pinpoint?.journey) {
+		return {
+			source: '_journey',
+			attributes: pinpoint.journey,
+		};
+	}
+};