@aws-amplify/notifications 2.0.1-console-preview.8f82e46.0 → 2.0.1-console-preview.b278dcb.0

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

@@ -1,4 +1,33 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-export { identifyUser } from './apis';
+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 {
+	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,65 @@
+// 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 {
+	OnPushNotificationMessageHandler,
+	PushNotificationEvent,
+	PushNotificationMessage,
+} from '../../../types';
+import { getAnalyticsEvent } from './getAnalyticsEvent';
+import { getChannelType } from './getChannelType';
+import { resolveConfig, resolveCredentials } from '../../../utils';
+
+const logger = new ConsoleLogger('PushNotification.recordMessageEvent');
+
+/**
+ * @internal
+ */
+export const createMessageEventRecorder =
+	(
+		event: PushNotificationEvent,
+		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: PushNotificationEvent;
+	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/{AWSPinpointProvider/utils.ts → pinpoint/utils/getAnalyticsEvent.ts}

@@ -1,25 +1,22 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import type { Event as AWSPinpointAnalyticsEvent } from '@aws-amplify/core/internals/aws-clients/pinpoint';
-import { ConsoleLogger } from '@aws-amplify/core/internals/utils';
-import { PushNotificationMessage } from '../../types';
-import {
-	AWSPinpointMessageEventSource,
-	AWSPinpointMessageEvent,
-} from './types';
+import { PinpointAnalyticsEvent } from '@aws-amplify/core/internals/providers/pinpoint';
+import { AnalyticsEventAttributes } from '../types';
+import { PushNotificationEvent, 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';
 
-export const logger = new ConsoleLogger('PushNotification.AWSPinpointProvider');
-
+/**
+ * @internal
+ */
 export const getAnalyticsEvent = (
 	{ data }: PushNotificationMessage,
-	event: AWSPinpointMessageEvent
-): AWSPinpointAnalyticsEvent | null => {
+	event: PushNotificationEvent
+): PinpointAnalyticsEvent | null => {
 	if (!data) {
 		return null;
 	}
@@ -29,20 +26,21 @@ export const getAnalyticsEvent = (
 	}
 	const { source, attributes } = eventAttributes;
 	return {
-		Attributes: attributes,
-		EventType: `${source}.${event}`,
-		Timestamp: new Date().toISOString(),
+		attributes,
+		name: `${source}.${event}`,
 	};
 };
 
-const getAnalyticsEventAttributes = (data: PushNotificationMessage['data']) => {
+const getAnalyticsEventAttributes = (
+	data: PushNotificationMessage['data']
+): AnalyticsEventAttributes => {
 	if (data.hasOwnProperty(ANDROID_CAMPAIGN_ID_KEY)) {
 		return {
-			source: AWSPinpointMessageEventSource.CAMPAIGN,
+			source: '_campaign',
 			attributes: {
-				campaign_activity_id: data[ANDROID_CAMPAIGN_ACTIVITY_ID_KEY],
-				campaign_id: data[ANDROID_CAMPAIGN_ID_KEY],
-				treatment_id: data[ANDROID_CAMPAIGN_TREATMENT_ID_KEY],
+				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,
 			},
 		};
 	}
@@ -52,13 +50,13 @@ const getAnalyticsEventAttributes = (data: PushNotificationMessage['data']) => {
 			: data.pinpoint;
 	if (pinpoint?.campaign) {
 		return {
-			source: AWSPinpointMessageEventSource.CAMPAIGN,
+			source: '_campaign',
 			attributes: pinpoint.campaign,
 		};
 	}
 	if (pinpoint?.journey) {
 		return {
-			source: AWSPinpointMessageEventSource.JOURNEY,
+			source: '_journey',
 			attributes: pinpoint.journey,
 		};
 	}

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

@@ -0,0 +1,25 @@
+// 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 { getOperatingSystem } from '@aws-amplify/react-native';
+import { ChannelType } from '../types';
+
+const operatingSystem = getOperatingSystem();
+const isAndroid = operatingSystem === 'android';
+const isIos = operatingSystem === 'ios';
+
+/**
+ * @internal
+ */
+export const getChannelType = (): ChannelType => {
+	if (isAndroid) {
+		// FCM was previously known as GCM and continues to be the channel type in Pinpoint
+		return 'GCM';
+	}
+	if (isIos) {
+		// If building in debug mode, use the APNs sandbox
+		return global['__DEV__'] ? 'APNS_SANDBOX' : 'APNS';
+	}
+	throw new PlatformNotSupportedError();
+};

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

@@ -0,0 +1,15 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import {
+	PushNotificationAction,
+	Category,
+	getAmplifyUserAgent,
+} from '@aws-amplify/core/internals/utils';
+
+export const getPushNotificationUserAgentString = (
+	action: PushNotificationAction
+) =>
+	getAmplifyUserAgent({
+		category: Category.PushNotification,
+		action,
+	});

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

@@ -0,0 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { createMessageEventRecorder } from './createMessageEventRecorder';
+export { getChannelType } from './getChannelType';
+export { getPushNotificationUserAgentString } from './getPushNotificationUserAgentString';

package/src/pushNotifications/{providers/index.ts → types/errors.ts}

@@ -1,4 +1,6 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-export { identifyUser } from './pinpoint/apis';
+export enum PushNotificationErrorCode {
+	NotInitialized = 'NotInitialized',
+}

package/src/pushNotifications/types/index.ts

@@ -0,0 +1,8 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export * from './errors';
+export * from './inputs';
+export * from './options';
+export * from './outputs';
+export * from './pushNotifications';

package/src/pushNotifications/types/inputs.ts

@@ -0,0 +1,45 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { UserProfile } from '@aws-amplify/core';
+import { PushNotificationServiceOptions } from './options';
+import {
+	OnPushNotificationMessageHandler,
+	OnTokenReceivedHandler,
+	PushNotificationPermissions,
+} from './pushNotifications';
+
+export type PushNotificationIdentifyUserInput<
+	ServiceOptions extends PushNotificationServiceOptions = PushNotificationServiceOptions
+> = {
+	/**
+	 * A User ID associated to the current device.
+	 */
+	userId: string;
+
+	/**
+	 * Additional information about the user and their device.
+	 */
+	userProfile: UserProfile;
+
+	/**
+	 * Options to be passed to the API.
+	 */
+	options?: ServiceOptions;
+};
+
+export type PushNotificationRequestPermissionsInput =
+	PushNotificationPermissions;
+
+export type PushNotificationSetBadgeCountInput = number;
+
+export type PushNotificationOnNotificationOpenedInput =
+	OnPushNotificationMessageHandler;
+
+export type PushNotificationOnNotificationReceivedInBackgroundInput =
+	OnPushNotificationMessageHandler;
+
+export type PushNotificationOnNotificationReceivedInForegroundInput =
+	OnPushNotificationMessageHandler;
+
+export type PushNotificationOnTokenReceivedInput = OnTokenReceivedHandler;

package/src/pushNotifications/types/options.ts

@@ -0,0 +1,7 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * Base type for service options.
+ */
+export type PushNotificationServiceOptions = Record<string, unknown>;

package/src/pushNotifications/types/outputs.ts

@@ -0,0 +1,28 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { EventListenerRemover } from '../../eventListeners';
+import {
+	PushNotificationMessage,
+	PushNotificationPermissionStatus,
+} from '../types';
+
+export type PushNotificationGetBadgeCountOutput = number;
+
+export type PushNotificationGetLaunchNotificationOutput =
+	PushNotificationMessage | null;
+
+export type PushNotificationGetPermissionStatusOutput =
+	PushNotificationPermissionStatus;
+
+export type PushNotificationRequestPermissionsOutput = boolean;
+
+export type PushNotificationOnNotificationOpenedOutput = EventListenerRemover;
+
+export type PushNotificationOnNotificationReceivedInBackgroundOutput =
+	EventListenerRemover;
+
+export type PushNotificationOnNotificationReceivedInForegroundOutput =
+	EventListenerRemover;
+
+export type PushNotificationOnTokenReceivedOutput = EventListenerRemover;

package/src/pushNotifications/types/pushNotifications.ts

@@ -0,0 +1,22 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import type { PushNotificationMessage } from '@aws-amplify/react-native';
+export type {
+	PushNotificationMessage,
+	PushNotificationPermissionStatus,
+	PushNotificationPermissions,
+} from '@aws-amplify/react-native';
+
+export type OnTokenReceivedHandler = (token: string) => void;
+
+export type OnPushNotificationMessageHandler = (
+	message: PushNotificationMessage
+) => void;
+
+export type PushNotificationEvent =
+	| 'backgroundMessageReceived'
+	| 'foregroundMessageReceived'
+	| 'launchNotificationsOpened'
+	| 'notificationOpened'
+	| 'tokenReceived';

package/src/pushNotifications/utils/index.ts

@@ -0,0 +1,7 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { initialize, isInitialized } from './initializationManager';
+export { resolveConfig } from './resolveConfig';
+export { resolveCredentials } from './resolveCredentials';
+export { getToken, setToken } from './tokenManager';

package/src/pushNotifications/utils/initializationManager.ts

@@ -0,0 +1,20 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+let initialized = false;
+
+/**
+ * Sets initialization status to true.
+ *
+ * @internal
+ */
+export const initialize = async () => {
+	initialized = true;
+};
+
+/**
+ * Returns the initialization status of push notifications.
+ *
+ * @internal
+ */
+export const isInitialized = () => initialized;

package/src/pushNotifications/utils/resolveConfig.ts

@@ -0,0 +1,16 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { Amplify } from '@aws-amplify/core';
+import { assert, PushNotificationValidationErrorCode } from '../errors';
+
+/**
+ * @internal
+ */
+export const resolveConfig = () => {
+	const { appId, region } =
+		Amplify.getConfig().Notifications?.PushNotification.Pinpoint ?? {};
+	assert(!!appId, PushNotificationValidationErrorCode.NoAppId);
+	assert(!!region, PushNotificationValidationErrorCode.NoRegion);
+	return { appId, region };
+};

package/src/pushNotifications/utils/resolveCredentials.ts

@@ -0,0 +1,14 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { fetchAuthSession } from '@aws-amplify/core';
+import { assert, PushNotificationValidationErrorCode } from '../errors';
+
+/**
+ * @internal
+ */
+export const resolveCredentials = async () => {
+	const { credentials, identityId } = await fetchAuthSession();
+	assert(!!credentials, PushNotificationValidationErrorCode.NoCredentials);
+	return { credentials, identityId };
+};

package/src/pushNotifications/utils/tokenManager.ts

@@ -0,0 +1,20 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+let token: string;
+
+/**
+ * Sets token.
+ *
+ * @internal
+ */
+export const setToken = (newToken: string) => {
+	token = newToken;
+};
+
+/**
+ * Returns the current token.
+ *
+ * @internal
+ */
+export const getToken = () => token;

package/lib/.tsbuildinfo

@@ -1,3 +0,0 @@
-{
-  "version": "3.8.3"
-}