@aws-amplify/notifications 2.0.1-console-preview.5a31ca1.0 → 2.0.1-console-preview.8d88eef.0

package/src/common/AWSPinpointProviderCommon/index.ts

@@ -1,300 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import {
-	Category,
-	ConsoleLogger,
-	CustomUserAgentDetails,
-	getAmplifyUserAgent,
-	InAppMessagingAction,
-	PushNotificationAction,
-	amplifyUuid,
-} from '@aws-amplify/core/internals/utils';
-import { Cache, fetchAuthSession } from '@aws-amplify/core';
-
-import {
-	Event as AWSPinpointAnalyticsEvent,
-	putEvents,
-	PutEventsInput,
-	updateEndpoint,
-	UpdateEndpointInput,
-} from '@aws-amplify/core/internals/aws-clients/pinpoint';
-
-import {
-	NotificationsCategory,
-	NotificationsSubCategory,
-	NotificationsProvider,
-	UserInfo,
-} from '../../types';
-import { PinpointUserInfo } from './types';
-
-export default abstract class AWSPinpointProviderCommon
-	implements NotificationsProvider
-{
-	static category: NotificationsCategory = 'Notifications';
-	static providerName = 'AWSPinpoint';
-
-	protected config: Record<string, any> = {};
-	protected endpointInitialized = false;
-	protected initialized = false;
-	protected logger: ConsoleLogger;
-
-	constructor(logger) {
-		this.logger = logger;
-	}
-
-	/**
-	 * get the category of the plugin
-	 */
-	getCategory() {
-		return AWSPinpointProviderCommon.category;
-	}
-
-	/**
-	 * get the sub-category of the plugin
-	 */
-	abstract getSubCategory(): NotificationsSubCategory;
-
-	/**
-	 * get provider name of the plugin
-	 */
-	getProviderName(): string {
-		return AWSPinpointProviderCommon.providerName;
-	}
-
-	configure(config = {}): Record<string, any> {
-		this.config = { ...this.config, ...config };
-		this.logger.debug(
-			`configure ${this.getProviderName()}${this.getSubCategory()}Provider`,
-			this.config
-		);
-		return this.config;
-	}
-
-	identifyUser = async (userId: string, userInfo: UserInfo): Promise<void> => {
-		if (!this.initialized) {
-			await this.init();
-		}
-		try {
-			await this.updateEndpoint(userId, userInfo);
-		} catch (err) {
-			this.logger.error('Error identifying user', err);
-			throw err;
-		}
-	};
-
-	protected init = async (): Promise<void> => {
-		const { endpointId, storage } = this.config;
-		const providerName = this.getProviderName();
-		try {
-			// Only run sync() if it's available (i.e. React Native)
-			if (typeof storage.sync === 'function') {
-				await storage.sync();
-			}
-			// If an endpoint was not provided via configuration, try to get it from cache
-			if (!endpointId) {
-				this.config.endpointId = await this.getEndpointId();
-			}
-			this.initialized = true;
-		} catch (err) {
-			this.logger.error(`Failed to initialize ${providerName}`, err);
-		}
-	};
-
-	private getUserAgentValue = (): string => {
-		let customUserAgentDetails: CustomUserAgentDetails;
-		if (this.getSubCategory() === 'PushNotification') {
-			customUserAgentDetails = {
-				category: Category.PushNotification,
-				action: PushNotificationAction.None,
-			};
-		} else {
-			customUserAgentDetails = {
-				category: Category.InAppMessaging,
-				action: InAppMessagingAction.IdentifyUser,
-			};
-		}
-
-		return getAmplifyUserAgent(customUserAgentDetails);
-	};
-
-	protected recordAnalyticsEvent = async (
-		event: AWSPinpointAnalyticsEvent
-	): Promise<void> => {
-		// Update credentials
-		this.config.credentials = await this.getCredentials();
-		// Assert required configuration properties to make `putEvents` request are present
-		this.assertNotEmptyConfiguration();
-		const { appId, credentials, endpointId, region } = this.config;
-
-		try {
-			// Create the PutEvents input
-			const input: PutEventsInput = {
-				ApplicationId: appId,
-				EventsRequest: {
-					BatchItem: {
-						[endpointId]: {
-							Endpoint: {},
-							Events: {
-								[amplifyUuid()]: event,
-							},
-						},
-					},
-				},
-			};
-			this.logger.debug('recording analytics event');
-			await putEvents(
-				{ credentials, region, userAgentValue: this.getUserAgentValue() },
-				input
-			);
-		} catch (err) {
-			this.logger.error('Error recording analytics event', err);
-			throw err;
-		}
-	};
-
-	protected updateEndpoint = async (
-		userId: string = null,
-		userInfo: PinpointUserInfo = null
-	): Promise<void> => {
-		const credentials = await this.getCredentials();
-		// Shallow compare to determine if credentials stored here are outdated
-		const credentialsUpdated =
-			!this.config.credentials ||
-			Object.keys(credentials).some(
-				key => credentials[key] !== this.config.credentials[key]
-			);
-		// If endpoint is already initialized, and nothing else is changing, just early return
-		if (
-			this.endpointInitialized &&
-			!credentialsUpdated &&
-			!userId &&
-			!userInfo
-		) {
-			return;
-		}
-		// Update credentials
-		this.config.credentials = credentials;
-		// Assert required configuration properties to make `updateEndpoint` request are present
-		this.assertNotEmptyConfiguration();
-		const { appId, endpointId, endpointInfo = {}, region } = this.config;
-		try {
-			const { address, attributes, demographic, location, metrics, optOut } =
-				userInfo ?? {};
-			// Create the UpdateEndpoint input, prioritizing passed in user info and falling back to
-			// defaults (if any) obtained from the config
-			const input: UpdateEndpointInput = {
-				ApplicationId: appId,
-				EndpointId: endpointId,
-				EndpointRequest: {
-					RequestId: amplifyUuid(),
-					EffectiveDate: new Date().toISOString(),
-					ChannelType: endpointInfo.channelType,
-					Address: address ?? endpointInfo.address,
-					Attributes: {
-						...endpointInfo.attributes,
-						...attributes,
-					},
-					Demographic: {
-						AppVersion: null,
-						Make: null,
-						Model: null,
-						ModelVersion: null,
-						Platform: null,
-						...this.transferKeyToUpperCase({
-							...endpointInfo.demographic,
-							...demographic,
-						}),
-					},
-					Location: this.transferKeyToUpperCase({
-						...endpointInfo.location,
-						...location,
-					}),
-					Metrics: {
-						...endpointInfo.metrics,
-						...metrics,
-					},
-					OptOut: optOut ?? endpointInfo.optOut,
-					User: {
-						UserId: userId ?? endpointInfo.userId ?? credentials.identityId,
-						UserAttributes: attributes ?? endpointInfo.userAttributes,
-					},
-				},
-			};
-			this.logger.debug('updating endpoint');
-			await updateEndpoint(
-				{ credentials, region, userAgentValue: this.getUserAgentValue() },
-				input
-			);
-			this.endpointInitialized = true;
-		} catch (err) {
-			throw err;
-		}
-	};
-
-	private getEndpointId = async (): Promise<string> => {
-		const { appId } = this.config;
-		// Each Pinpoint channel requires its own Endpoint ID
-		// However, Push will share the Analytics endpoint for now so as to not break existing customers
-		const cacheKey =
-			this.getSubCategory() === 'PushNotification'
-				? `${this.getProviderName()}_${appId}`
-				: `${this.getSubCategory()}:${this.getProviderName()}:${appId}`;
-		// First attempt to retrieve the ID from cache
-		const cachedEndpointId = await Cache.getItem(cacheKey);
-		// Found in cache, just return it
-		if (cachedEndpointId) {
-			return cachedEndpointId;
-		}
-		// Otherwise, generate a new ID and store it in long-lived cache before returning it
-		const endpointId = amplifyUuid();
-		// Set a longer TTL to avoid endpoint id being deleted after the default TTL (3 days)
-		// Also set its priority to the highest to reduce its chance of being deleted when cache is full
-		const ttl = 1000 * 60 * 60 * 24 * 365 * 100; // 100 years
-		const expiration = new Date().getTime() + ttl;
-		Cache.setItem(cacheKey, endpointId, {
-			expires: expiration,
-			priority: 1,
-		});
-		return endpointId;
-	};
-
-	private getCredentials = async () => {
-		try {
-			const session = await fetchAuthSession();
-			if (!session.credentials) {
-				this.logger.debug('no credentials found');
-				return null;
-			}
-			return { ...session.credentials, identityId: session.identityId };
-		} catch (err) {
-			this.logger.error('Error getting credentials:', err);
-			return null;
-		}
-	};
-
-	private assertNotEmptyConfiguration = () => {
-		const { appId, credentials, region } = this.config;
-		if (!appId || !credentials || !region) {
-			throw new Error(
-				'One or more of credentials, appId or region is not configured'
-			);
-		}
-	};
-
-	/**
-	 * transfer the first letter of the keys to lowercase
-	 * @param {Object} obj - the object need to be transferred
-	 */
-	private transferKeyToUpperCase = (obj: Record<string, any>) => {
-		const ret: Record<string, any> = {};
-
-		for (const key in obj) {
-			if (obj.hasOwnProperty(key)) {
-				const transferredKey = key[0].toUpperCase() + key.slice(1);
-				ret[transferredKey] = this.transferKeyToUpperCase(obj[key]);
-			}
-		}
-		return ret;
-	};
-}

package/src/common/AWSPinpointProviderCommon/types.ts

@@ -1,29 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import { UserInfo } from '../../types';
-
-export interface PinpointProviderConfig {
-	appId: string;
-	region: string;
-}
-
-export interface PinpointUserInfo extends UserInfo {
-	address?: string;
-	optOut?: 'ALL' | 'NONE';
-}
-
-export type ChannelType =
-	| 'ADM'
-	| 'APNS'
-	| 'APNS_SANDBOX'
-	| 'APNS_VOIP'
-	| 'APNS_VOIP_SANDBOX'
-	| 'BAIDU'
-	| 'CUSTOM'
-	| 'EMAIL'
-	| 'GCM'
-	| 'IN_APP'
-	| 'PUSH'
-	| 'SMS'
-	| 'VOICE';

package/src/inAppMessaging/providers/pinpoint/types/errors.ts

@@ -1,12 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-export enum UpdateEndpointException {
-	BadRequestException = 'BadRequestException',
-	ForbiddenException = 'ForbiddenException',
-	InternalServerErrorException = 'InternalServerErrorException',
-	MethodNotAllowedException = 'MethodNotAllowedException',
-	NotFoundException = 'NotFoundException',
-	PayloadTooLargeException = 'PayloadTooLargeException',
-	TooManyRequestsException = 'TooManyRequestsException',
-}

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/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>;
-}