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

package/src/InAppMessaging/SessionTracker/SessionTracker.ts

@@ -1,78 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-import { browserOrNode, ConsoleLogger as Logger } from '@aws-amplify/core';
-import noop from 'lodash/noop';
-import {
-	SessionState,
-	SessionStateChangeHandler,
-	SessionTrackerInterface,
-} from './types';
-
-// Per https://developer.mozilla.org/en-US/docs/Web/API/Page_Visibility_API
-let hidden: string;
-let visibilityChange: string;
-const { isBrowser } = browserOrNode();
-
-if (isBrowser && document) {
-	if (typeof document.hidden !== 'undefined') {
-		hidden = 'hidden';
-		visibilityChange = 'visibilitychange';
-	} else if (typeof document['msHidden'] !== 'undefined') {
-		hidden = 'msHidden';
-		visibilityChange = 'msvisibilitychange';
-	} else if (typeof document['webkitHidden'] !== 'undefined') {
-		hidden = 'webkitHidden';
-		visibilityChange = 'webkitvisibilitychange';
-	}
-}
-
-const logger = new Logger('InAppMessagingSessionTracker');
-
-export default class SessionTracker implements SessionTrackerInterface {
-	private sessionStateChangeHandler: SessionStateChangeHandler;
-
-	constructor(sessionStateChangeHandler: SessionStateChangeHandler = noop) {
-		this.sessionStateChangeHandler = sessionStateChangeHandler;
-	}
-
-	start = (): SessionState => {
-		if (isBrowser) {
-			document?.addEventListener(
-				visibilityChange,
-				this.visibilityChangeHandler
-			);
-		}
-		return this.getSessionState();
-	};
-
-	end = (): SessionState => {
-		if (isBrowser) {
-			document?.removeEventListener(
-				visibilityChange,
-				this.visibilityChangeHandler
-			);
-		}
-		return this.getSessionState();
-	};
-
-	private getSessionState = (): SessionState => {
-		if (isBrowser && document && !document[hidden]) {
-			return 'started';
-		}
-		// If, for any reason, document is undefined the session will never start
-		return 'ended';
-	};
-
-	private visibilityChangeHandler = () => {
-		if (!isBrowser || !document) {
-			return;
-		}
-		if (document[hidden]) {
-			logger.debug('App is now hidden');
-			this.sessionStateChangeHandler('ended');
-		} else {
-			logger.debug('App is now visible');
-			this.sessionStateChangeHandler('started');
-		}
-	};
-}

package/src/InAppMessaging/SessionTracker/index.ts

@@ -1,6 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import { default as SessionTracker } from './SessionTracker';
-export * from './types';
-export default SessionTracker;

package/src/InAppMessaging/SessionTracker/types.ts

@@ -1,11 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-export type SessionState = 'started' | 'ended';
-
-export type SessionStateChangeHandler = (state: SessionState) => void;
-
-export interface SessionTrackerInterface {
-	start: () => SessionState;
-	end: () => SessionState;
-}

package/src/InAppMessaging/types.ts

@@ -1,142 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import { EventListener } from '../common';
-import { AWSPinpointProviderConfig } from '../common/AWSPinpointProviderCommon/types';
-import {
-	NotificationsProvider,
-	NotificationsSubCategory as NotificationsSubCategories,
-	UserInfo,
-} from '../types';
-
-export type NotificationsSubCategory = Extract<
-	NotificationsSubCategories,
-	'InAppMessaging'
->;
-
-export interface InAppMessagingInterface {
-	configure: (config: InAppMessagingConfig) => InAppMessagingConfig;
-	getModuleName: () => NotificationsSubCategory;
-	getPluggable: (providerName: string) => InAppMessagingProvider;
-	addPluggable: (pluggable: InAppMessagingProvider) => void;
-	removePluggable: (providerName: string) => void;
-	syncMessages: () => Promise<void[]>;
-	clearMessages: () => Promise<void[]>;
-	dispatchEvent: (event: InAppMessagingEvent) => Promise<void>;
-	identifyUser: (userId: string, userInfo: UserInfo) => Promise<void[]>;
-	onMessageReceived: (
-		handler: OnMessageInteractionEventHandler
-	) => EventListener<OnMessageInteractionEventHandler>;
-	onMessageDisplayed: (
-		handler: OnMessageInteractionEventHandler
-	) => EventListener<OnMessageInteractionEventHandler>;
-	onMessageDismissed: (
-		handler: OnMessageInteractionEventHandler
-	) => EventListener<OnMessageInteractionEventHandler>;
-	onMessageActionTaken: (
-		handler: OnMessageInteractionEventHandler
-	) => EventListener<OnMessageInteractionEventHandler>;
-	notifyMessageInteraction: (
-		message: InAppMessage,
-		type: InAppMessageInteractionEvent
-	) => void;
-	setConflictHandler: (handler: InAppMessageConflictHandler) => void;
-}
-
-export interface InAppMessagingProvider extends NotificationsProvider {
-	// return sub-category ('InAppMessaging')
-	getSubCategory(): NotificationsSubCategory;
-
-	// get in-app messages from provider
-	getInAppMessages(): Promise<any>;
-
-	// filters in-app messages based on event input and provider logic
-	processInAppMessages(
-		messages: InAppMessage[],
-		event: InAppMessagingEvent
-	): Promise<InAppMessage[]>;
-}
-
-export interface InAppMessagingConfig {
-	listenForAnalyticsEvents?: boolean;
-	AWSPinpoint?: AWSPinpointProviderConfig;
-}
-
-export type InAppMessagingEvent = {
-	name: string;
-	attributes?: Record<string, string>;
-	metrics?: Record<string, number>;
-};
-
-export type InAppMessageLayout =
-	| 'BOTTOM_BANNER'
-	| 'CAROUSEL'
-	| 'FULL_SCREEN'
-	| 'MIDDLE_BANNER'
-	| 'MODAL'
-	| 'TOP_BANNER';
-
-export type InAppMessageAction = 'CLOSE' | 'DEEP_LINK' | 'LINK';
-
-export type InAppMessageTextAlign = 'center' | 'left' | 'right';
-
-interface InAppMessageContainer {
-	style?: InAppMessageStyle;
-}
-
-interface InAppMessageHeader {
-	content: string;
-	style?: InAppMessageStyle;
-}
-
-interface InAppMessageBody {
-	content: string;
-	style?: InAppMessageStyle;
-}
-
-export interface InAppMessageImage {
-	src: string;
-}
-
-export interface InAppMessageButton {
-	title: string;
-	action: InAppMessageAction;
-	url?: string;
-	style?: InAppMessageStyle;
-}
-
-export interface InAppMessageStyle {
-	backgroundColor?: string;
-	borderRadius?: number;
-	color?: string;
-	textAlign?: InAppMessageTextAlign;
-}
-
-export interface InAppMessageContent {
-	container?: InAppMessageContainer;
-	header?: InAppMessageHeader;
-	body?: InAppMessageBody;
-	image?: InAppMessageImage;
-	primaryButton?: InAppMessageButton;
-	secondaryButton?: InAppMessageButton;
-}
-
-export interface InAppMessage {
-	id: string;
-	layout: InAppMessageLayout;
-	content: InAppMessageContent[];
-	metadata?: any;
-}
-
-export type OnMessageInteractionEventHandler = (message: InAppMessage) => any;
-
-export enum InAppMessageInteractionEvent {
-	MESSAGE_RECEIVED = 'MESSAGE_RECEIVED_EVENT',
-	MESSAGE_DISPLAYED = 'MESSAGE_DISPLAYED_EVENT',
-	MESSAGE_DISMISSED = 'MESSAGE_DISMISSED_EVENT',
-	MESSAGE_ACTION_TAKEN = 'MESSAGE_ACTION_TAKEN_EVENT',
-}
-
-export type InAppMessageConflictHandler = (
-	messages: InAppMessage[]
-) => InAppMessage;

package/src/Notifications.ts

@@ -1,90 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import { Amplify, ConsoleLogger as Logger } from '@aws-amplify/core';
-
-import InAppMessagingClass from './InAppMessaging';
-import PushNotificationClass from './PushNotification';
-import { InAppMessagingInterface as InAppMessaging } from './InAppMessaging/types';
-import { PushNotificationInterface as PushNotification } from './PushNotification/types';
-import { NotificationsCategory, NotificationsConfig, UserInfo } from './types';
-
-const logger = new Logger('Notifications');
-
-class NotificationsClass {
-	private config: Record<string, any> = {};
-	private inAppMessaging: InAppMessaging;
-	private pushNotification?: PushNotification;
-
-	constructor() {
-		this.inAppMessaging = new InAppMessagingClass();
-	}
-
-	/**
-	 * Get the name of the module category
-	 * @returns {string} name of the module category
-	 */
-	getModuleName(): NotificationsCategory {
-		return 'Notifications';
-	}
-
-	/**
-	 * Configure Notifications
-	 * @param {Object} config - Notifications configuration object
-	 */
-	configure = ({ Notifications: config }: NotificationsConfig = {}) => {
-		this.config = { ...this.config, ...config };
-
-		logger.debug('configure Notifications', config);
-
-		// Configure sub-categories
-		this.inAppMessaging.configure(this.config.InAppMessaging);
-
-		if (this.config.Push) {
-			try {
-				// only instantiate once
-				if (!this.pushNotification) {
-					this.pushNotification = new PushNotificationClass();
-				}
-				this.pushNotification.configure(this.config.Push);
-			} catch (err) {
-				logger.error(err);
-			}
-		}
-
-		return this.config;
-	};
-
-	get InAppMessaging(): InAppMessaging {
-		return this.inAppMessaging;
-	}
-
-	get Push(): PushNotification {
-		return this.pushNotification ?? ({} as PushNotification);
-	}
-
-	identifyUser = (userId: string, userInfo: UserInfo): Promise<void[]> => {
-		const identifyFunctions: Function[] = [];
-		if (this.inAppMessaging) {
-			identifyFunctions.push(this.inAppMessaging.identifyUser);
-		}
-		if (this.pushNotification) {
-			identifyFunctions.push(this.pushNotification.identifyUser);
-		}
-		return Promise.all<void>(
-			identifyFunctions.map(async identifyFunction => {
-				try {
-					await identifyFunction(userId, userInfo);
-				} catch (err) {
-					logger.error('Failed to identify user', err);
-					throw err;
-				}
-			})
-		);
-	};
-}
-
-const Notifications = new NotificationsClass();
-
-export default Notifications;
-Amplify.register(Notifications);

package/src/PushNotification/NotEnabledError.ts

@@ -1,11 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-export default class NotEnabledError extends Error {
-	constructor() {
-		super(
-			'Function is unavailable as Push has not been enabled. Please call `Push.enable` before calling this function.'
-		);
-		this.name = 'NotEnabledError';
-	}
-}

package/src/PushNotification/Platform/index.native.ts

@@ -1,9 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import { Platform as NativePlatform } from 'react-native';
-import { Platform as PlatformInterface } from './types';
-
-const { OS } = NativePlatform;
-
-export const Platform: PlatformInterface = { OS };

package/src/PushNotification/Platform/index.ts

@@ -1,22 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import { Platform as PlatformInterface } from './types';
-
-const userAgentIncludes = (text: string): boolean => {
-	return navigator?.userAgent?.includes(text);
-};
-
-const getOS = (): PlatformInterface['OS'] => {
-	if (userAgentIncludes('Android')) return 'android';
-	if (userAgentIncludes('like Mac')) return 'ios';
-	if (userAgentIncludes('Win')) return 'windows';
-	if (userAgentIncludes('Mac')) return 'macos';
-	if (userAgentIncludes('Linux')) return 'linux';
-	if (userAgentIncludes('X11')) return 'unix';
-	return 'unknown';
-};
-
-const OS = getOS();
-
-export const Platform: PlatformInterface = { OS };

package/src/PushNotification/Platform/types.ts

@@ -1,15 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-export interface Platform {
-	OS: KnownOS | 'unknown';
-}
-
-type KnownOS =
-	| 'windows'
-	| 'macos'
-	| 'unix'
-	| 'linux'
-	| 'ios'
-	| 'android'
-	| 'web';

package/src/PushNotification/PlatformNotSupportedError.ts

@@ -1,9 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-export default class PlatformNotSupportedError extends Error {
-	constructor() {
-		super('Function not supported on current platform');
-		this.name = 'PlatformNotSupportedError';
-	}
-}

package/src/PushNotification/Providers/AWSPinpointProvider/index.ts

@@ -1,137 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import { addEventListener, AWSPinpointProviderCommon } from '../../../common';
-import { ChannelType } from '../../../common/AWSPinpointProviderCommon/types';
-import PlatformNotSupportedError from '../../PlatformNotSupportedError';
-import { Platform } from '../../Platform';
-import {
-	PushNotificationEvent,
-	PushNotificationMessage,
-	PushNotificationProvider,
-	NotificationsSubCategory,
-} from '../../types';
-import { AWSPinpointMessageEvent } from './types';
-import {
-	dispatchPushNotificationEvent,
-	getAnalyticsEvent,
-	logger,
-} from './utils';
-
-export default class AWSPinpointProvider
-	extends AWSPinpointProviderCommon
-	implements PushNotificationProvider
-{
-	static subCategory: NotificationsSubCategory = 'PushNotification';
-
-	private configured = false;
-
-	constructor() {
-		super(logger);
-	}
-
-	/**
-	 * get the sub-category of the plugin
-	 */
-	getSubCategory() {
-		return AWSPinpointProvider.subCategory;
-	}
-
-	configure = (config = {}): Record<string, any> => {
-		this.config = {
-			...super.configure(config),
-			endpointInfo: { channelType: this.getChannelType() },
-		};
-
-		// some configuration steps should not be re-run even if provider is re-configured for some reason
-		if (!this.configured) {
-			// wire up default Pinpoint message event handling
-			addEventListener(
-				PushNotificationEvent.BACKGROUND_MESSAGE_RECEIVED,
-				message =>
-					this.recordMessageEvent(
-						message,
-						AWSPinpointMessageEvent.BACKGROUND_MESSAGE_RECEIVED
-					)
-			);
-			addEventListener(
-				PushNotificationEvent.FOREGROUND_MESSAGE_RECEIVED,
-				message =>
-					this.recordMessageEvent(
-						message,
-						AWSPinpointMessageEvent.FOREGROUND_MESSAGE_RECEIVED
-					)
-			);
-			const launchNotificationOpenedListener = addEventListener(
-				PushNotificationEvent.LAUNCH_NOTIFICATION_OPENED,
-				message => {
-					this.recordMessageEvent(
-						message,
-						AWSPinpointMessageEvent.NOTIFICATION_OPENED
-					);
-					// once we are done with it we can remove the listener
-					launchNotificationOpenedListener?.remove();
-				}
-			);
-			addEventListener(PushNotificationEvent.NOTIFICATION_OPENED, message => {
-				this.recordMessageEvent(
-					message,
-					AWSPinpointMessageEvent.NOTIFICATION_OPENED
-				);
-				// if we are in this state, we no longer need the listener as the app was launched via some other means
-				launchNotificationOpenedListener?.remove();
-			});
-		}
-
-		this.configured = true;
-		dispatchPushNotificationEvent('pinpointProvider_configured', null);
-		return this.config;
-	};
-
-	registerDevice = async (address: string): Promise<void> => {
-		if (!this.initialized) {
-			await this.init();
-		}
-		try {
-			this.config.endpointInfo = {
-				...this.config.endpointInfo,
-				address,
-			};
-			await this.updateEndpoint();
-		} catch (err) {
-			this.logger.error('Error registering device', err);
-			throw err;
-		}
-	};
-
-	private getChannelType = (): ChannelType => {
-		switch (Platform.OS) {
-			case 'android': {
-				// FCM was previously known as GCM and continues to be the channel type in Pinpoint
-				return 'GCM';
-			}
-			case 'ios': {
-				// If building in debug mode, use the APNs sandbox
-				return global['__DEV__'] ? 'APNS_SANDBOX' : 'APNS';
-			}
-			default: {
-				throw new PlatformNotSupportedError();
-			}
-		}
-	};
-
-	private recordMessageEvent = async (
-		message: PushNotificationMessage,
-		event: AWSPinpointMessageEvent
-	): Promise<void> => {
-		const analyticsEvent = getAnalyticsEvent(message, event);
-		if (!analyticsEvent) {
-			logger.debug('A notification missing event information was not recorded');
-			return;
-		}
-		if (!this.initialized) {
-			await this.init();
-		}
-		return this.recordAnalyticsEvent(analyticsEvent);
-	};
-}

package/src/PushNotification/Providers/AWSPinpointProvider/types.ts

@@ -1,13 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-export enum AWSPinpointMessageEventSource {
-	CAMPAIGN = '_campaign',
-	JOURNEY = '_journey',
-}
-
-export enum AWSPinpointMessageEvent {
-	NOTIFICATION_OPENED = 'opened_notification',
-	BACKGROUND_MESSAGE_RECEIVED = 'received_background',
-	FOREGROUND_MESSAGE_RECEIVED = 'received_foreground',
-}

package/src/PushNotification/Providers/AWSPinpointProvider/utils.ts

@@ -1,79 +0,0 @@
-// 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, Hub } from '@aws-amplify/core';
-import { AMPLIFY_SYMBOL } from '../../../common';
-import { PushNotificationMessage } from '../../types';
-import {
-	AWSPinpointMessageEventSource,
-	AWSPinpointMessageEvent,
-} 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');
-
-export const dispatchPushNotificationEvent = (
-	event: string,
-	data: any,
-	message?: string
-) => {
-	Hub.dispatch(
-		'pushNotification',
-		{ event, data, message },
-		'PushNotification',
-		AMPLIFY_SYMBOL
-	);
-};
-
-export const getAnalyticsEvent = (
-	{ data }: PushNotificationMessage,
-	event: AWSPinpointMessageEvent
-): AWSPinpointAnalyticsEvent | null => {
-	if (!data) {
-		return null;
-	}
-	const eventAttributes = getAnalyticsEventAttributes(data);
-	if (!eventAttributes) {
-		return null;
-	}
-	const { source, attributes } = eventAttributes;
-	return {
-		Attributes: attributes,
-		EventType: `${source}.${event}`,
-		Timestamp: new Date().toISOString(),
-	};
-};
-
-const getAnalyticsEventAttributes = (data: PushNotificationMessage['data']) => {
-	if (data.hasOwnProperty(ANDROID_CAMPAIGN_ID_KEY)) {
-		return {
-			source: AWSPinpointMessageEventSource.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],
-			},
-		};
-	}
-	const pinpoint =
-		typeof data.pinpoint === 'string'
-			? JSON.parse(data.pinpoint)
-			: data.pinpoint;
-	if (pinpoint?.campaign) {
-		return {
-			source: AWSPinpointMessageEventSource.CAMPAIGN,
-			attributes: pinpoint.campaign,
-		};
-	}
-	if (pinpoint?.journey) {
-		return {
-			source: AWSPinpointMessageEventSource.JOURNEY,
-			attributes: pinpoint.journey,
-		};
-	}
-};