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

package/src/inAppMessaging/sessionTracker/SessionTracker.ts

@@ -1,80 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-import {
-	ConsoleLogger as Logger,
-	isBrowser,
-} from '@aws-amplify/core/internals/utils';
-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;
-
-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/config.ts

@@ -1,8 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-import { PinpointProviderConfig } from '../../common/AWSPinpointProviderCommon/types';
-
-export interface InAppMessagingConfig {
-	listenForAnalyticsEvents?: boolean;
-	AWSPinpoint?: PinpointProviderConfig;
-}

package/src/pushNotifications/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/pushNotifications/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/pushNotifications/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/pushNotifications/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/pushNotifications/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/pushNotifications/providers/AWSPinpointProvider/index.ts

@@ -1,93 +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 {
-	PushNotificationMessage,
-	PushNotificationProvider,
-	NotificationsSubCategory,
-} from '../../types';
-import { AWSPinpointMessageEvent } from './types';
-import { 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('backgroundMessageReceived', message =>
-				this.recordMessageEvent(
-					message,
-					AWSPinpointMessageEvent.BACKGROUND_MESSAGE_RECEIVED
-				)
-			);
-			addEventListener('foregroundMessageReceived', message =>
-				this.recordMessageEvent(
-					message,
-					AWSPinpointMessageEvent.FOREGROUND_MESSAGE_RECEIVED
-				)
-			);
-			const launchNotificationOpenedListener = addEventListener(
-				'launchNotificationsOpened',
-				message => {
-					this.recordMessageEvent(
-						message,
-						AWSPinpointMessageEvent.NOTIFICATION_OPENED
-					);
-					// once we are done with it we can remove the listener
-					launchNotificationOpenedListener?.remove();
-				}
-			);
-			addEventListener('notificationOpened', 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;
-		return this.config;
-	};
-
-	registerDevice = async (address: string): Promise<void> => {
-		throw new Error('WIP');
-	};
-
-	private getChannelType = (): ChannelType => {
-		throw new Error('WIP');
-	};
-
-	private recordMessageEvent = async (
-		message: PushNotificationMessage,
-		event: AWSPinpointMessageEvent
-	): Promise<void> => {
-		throw new Error('WIP');
-	};
-}

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

@@ -1,114 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import { EventListener } from '../common';
-import { PinpointProviderConfig } from '../common/AWSPinpointProviderCommon/types';
-import {
-	NotificationsProvider,
-	NotificationsSubCategory as NotificationsSubCategories,
-	UserInfo,
-} from '../types';
-
-export type NotificationsSubCategory = Extract<
-	NotificationsSubCategories,
-	'PushNotification'
->;
-
-export interface PushNotificationInterface {
-	configure: (config: PushNotificationConfig) => PushNotificationConfig;
-	getModuleName: () => NotificationsSubCategory;
-	getPluggable: (providerName: string) => PushNotificationProvider;
-	addPluggable: (pluggable: PushNotificationProvider) => void;
-	removePluggable: (providerName: string) => void;
-	enable: () => void;
-	identifyUser: (userId: string, userInfo: UserInfo) => Promise<void[]>;
-	getLaunchNotification: () => Promise<PushNotificationMessage>;
-	getBadgeCount: () => Promise<number>;
-	setBadgeCount: (count: number) => void;
-	getPermissionStatus: () => Promise<PushNotificationPermissionStatus>;
-	requestPermissions: (
-		permissions?: PushNotificationPermissions
-	) => Promise<boolean>;
-	onNotificationReceivedInBackground: (
-		handler: OnPushNotificationMessageHandler
-	) => EventListener<OnPushNotificationMessageHandler>;
-	onNotificationReceivedInForeground: (
-		handler: OnPushNotificationMessageHandler
-	) => EventListener<OnPushNotificationMessageHandler>;
-	onNotificationOpened: (
-		handler: OnPushNotificationMessageHandler
-	) => EventListener<OnPushNotificationMessageHandler>;
-	onTokenReceived: (
-		handler: OnTokenReceivedHandler
-	) => EventListener<OnTokenReceivedHandler>;
-}
-
-export interface PushNotificationProvider extends NotificationsProvider {
-	// return sub-category ('PushNotification')
-	getSubCategory(): NotificationsSubCategory;
-
-	// register device with provider
-	registerDevice(token: string): Promise<void>;
-}
-
-export interface PushNotificationConfig {
-	Pinpoint?: PinpointProviderConfig;
-}
-
-export interface PushNotificationMessage {
-	title?: string;
-	body?: string;
-	imageUrl?: string;
-	deeplinkUrl?: string;
-	goToUrl?: string;
-	fcmOptions?: FcmPlatformOptions;
-	apnsOptions?: ApnsPlatformOptions;
-	data?: Record<string, unknown>;
-}
-
-interface FcmPlatformOptions {
-	channelId: string;
-	messageId: string;
-	senderId: string;
-	sendTime: Date;
-}
-
-interface ApnsPlatformOptions {
-	subtitle?: string;
-}
-
-export interface PushNotificationPermissions
-	extends Partial<Record<string, boolean>> {
-	alert?: boolean;
-	badge?: boolean;
-	sound?: boolean;
-}
-
-export enum PushNotificationPermissionStatus {
-	DENIED = 'DENIED',
-	GRANTED = 'GRANTED',
-	SHOULD_REQUEST = 'SHOULD_REQUEST',
-	SHOULD_EXPLAIN_THEN_REQUEST = 'SHOULD_EXPLAIN_THEN_REQUEST',
-}
-
-export type OnTokenReceivedHandler = (token: string) => any;
-
-export type OnPushNotificationMessageHandler = (
-	message: PushNotificationMessage
-) => any;
-
-export type PushNotificationEvent =
-	| 'backgroundMessageReceived'
-	| 'foregroundMessageReceived'
-	| 'launchNotificationsOpened'
-	| 'notificationOpened'
-	| 'tokenReceived';
-
-export interface NormalizedValues {
-	body?: string;
-	imageUrl?: string;
-	title?: string;
-	action?: Pick<PushNotificationMessage, 'goToUrl' | 'deeplinkUrl'>;
-	options?: Pick<PushNotificationMessage, 'apnsOptions' | 'fcmOptions'>;
-	data?: Record<string, unknown>;
-}

package/src/pushNotifications/utils.ts

@@ -1,112 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import { isEmpty } from 'lodash';
-
-import {
-	NormalizedValues,
-	PushNotificationMessage,
-	PushNotificationPermissionStatus,
-} from './types';
-
-const DEEP_LINK_ACTION = 'deeplink';
-const URL_ACTION = 'url';
-
-export const normalizeNativePermissionStatus = (
-	nativeStatus?
-): PushNotificationPermissionStatus => {
-	switch (nativeStatus) {
-		case 'ShouldRequest':
-			return PushNotificationPermissionStatus.SHOULD_REQUEST;
-		case 'NotDetermined':
-		case 'ShouldExplainThenRequest':
-			return PushNotificationPermissionStatus.SHOULD_EXPLAIN_THEN_REQUEST;
-		case 'Authorized':
-		case 'Granted':
-			return PushNotificationPermissionStatus.GRANTED;
-		case 'Denied':
-			return PushNotificationPermissionStatus.DENIED;
-	}
-};
-
-export const normalizeNativeMessage = (
-	nativeMessage?
-): PushNotificationMessage | null => {
-	let normalized: NormalizedValues;
-	if (nativeMessage?.aps) {
-		normalized = normalizeApnsMessage(nativeMessage);
-	}
-	if (nativeMessage?.rawData) {
-		normalized = normalizeFcmMessage(nativeMessage);
-	}
-	if (!normalized) {
-		return null;
-	}
-	const { body, imageUrl, title, action, options, data } = normalized;
-	return {
-		...(body && { body }),
-		...(imageUrl && { imageUrl }),
-		...(title && { title }),
-		...action,
-		...options,
-		...(!isEmpty(data) && { data }),
-	};
-};
-
-const normalizeApnsMessage = (apnsMessage): NormalizedValues => {
-	const { aps, data = {} } = apnsMessage;
-	const { body, title } = aps.alert ?? {};
-	const action = getApnsAction(data.pinpoint) ?? {};
-	const imageUrl = data['media-url'];
-	const options = getApnsOptions(apnsMessage);
-	return { body, imageUrl, title, action, options, data };
-};
-
-const normalizeFcmMessage = (fcmMessage): NormalizedValues => {
-	const { body, imageUrl, rawData: data, title } = fcmMessage;
-	const action = getFcmAction(fcmMessage.action) ?? {};
-	const options = getFcmOptions(fcmMessage);
-	return { body, imageUrl, title, action, options, data };
-};
-
-const getApnsAction = (
-	action = {}
-): Pick<PushNotificationMessage, 'deeplinkUrl'> => {
-	if (action[DEEP_LINK_ACTION]) {
-		return { deeplinkUrl: action[DEEP_LINK_ACTION] };
-	}
-};
-
-const getFcmAction = (
-	action = {}
-): Pick<PushNotificationMessage, 'goToUrl' | 'deeplinkUrl'> => {
-	if (action[URL_ACTION]) {
-		return { goToUrl: action[URL_ACTION] };
-	}
-	if (action[DEEP_LINK_ACTION]) {
-		return { deeplinkUrl: action[DEEP_LINK_ACTION] };
-	}
-};
-
-const getApnsOptions = ({
-	aps,
-}): Pick<PushNotificationMessage, 'apnsOptions'> => {
-	const { subtitle } = aps.alert ?? {};
-	const apnsOptions = { ...(subtitle && { subtitle }) };
-	return { ...(!isEmpty(apnsOptions) && { apnsOptions }) };
-};
-
-const getFcmOptions = ({
-	channelId,
-	messageId,
-	senderId,
-	sendTime,
-}): Pick<PushNotificationMessage, 'fcmOptions'> => {
-	const fcmOptions = {
-		...(channelId && { channelId }),
-		...(messageId && { messageId }),
-		...(senderId && { senderId }),
-		...(sendTime && { sendTime: new Date(sendTime) }),
-	};
-	return { ...(!isEmpty(fcmOptions) && { fcmOptions }) };
-};

package/src/types.ts

@@ -1,56 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import { InAppMessagingConfig } from './inAppMessaging/types';
-import { PushNotificationConfig } from './pushNotifications/types';
-
-export type NotificationsCategory = 'Notifications';
-
-export type NotificationsSubCategory = 'InAppMessaging' | 'PushNotification';
-
-export interface NotificationsProvider {
-	// configure provider
-	configure(config: object): object;
-
-	// return category ('Notifications')
-	getCategory(): NotificationsCategory;
-
-	// return sub-category
-	getSubCategory(): NotificationsSubCategory;
-
-	// return the name of you provider
-	getProviderName(): string;
-
-	// identify the current user with the provider
-	identifyUser(userId: string, userInfo: UserInfo): Promise<void>;
-}
-
-export interface NotificationsConfig {
-	Notifications?: {
-		InAppMessaging?: InAppMessagingConfig;
-		PushNotification?: PushNotificationConfig;
-	};
-}
-
-export type UserInfo = {
-	attributes?: Record<string, string[]>;
-	demographic?: {
-		appVersion?: string;
-		locale?: string;
-		make?: string;
-		model?: string;
-		modelVersion?: string;
-		platform?: string;
-		platformVersion?: string;
-		timezone?: string;
-	};
-	location?: {
-		city?: string;
-		country?: string;
-		latitude?: number;
-		longitude?: number;
-		postalCode?: string;
-		region?: string;
-	};
-	metrics?: Record<string, number>;
-};