@aws-amplify/notifications 1.0.25 → 1.0.26-unstable.1116fef.4

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@aws-amplify/notifications",
-	"version": "1.0.25",
+	"version": "1.0.26-unstable.1116fef.4+1116feff6",
 	"description": "Notifications category of aws-amplify",
 	"main": "./lib/index.js",
 	"module": "./lib-esm/index.js",
@@ -13,7 +13,9 @@
 		"access": "public"
 	},
 	"scripts": {
-		"test": "npm run lint && jest -w 1 --coverage",
+		"test": "npm run lint && npm run test:default && npm run test:native",
+		"test:default": "jest -w 1 --coverage",
+		"test:native": "jest -w 1 --coverage --config=jest.native.config.js --coverageDirectory=coverage-native",
 		"test:watch": "tslint 'src/**/*.ts' && jest -w 1 --watch",
 		"test:size": "size-limit",
 		"build-with-test": "npm run clean && npm test && tsc && webpack",
@@ -47,8 +49,8 @@
 		"src"
 	],
 	"dependencies": {
-		"@aws-amplify/cache": "5.0.25",
-		"@aws-amplify/core": "5.1.8",
+		"@aws-amplify/cache": "5.0.26-unstable.1116fef.4+1116feff6",
+		"@aws-amplify/core": "5.1.9-unstable.1116fef.4+1116feff6",
 		"@aws-sdk/client-pinpoint": "3.186.1",
 		"lodash": "^4.17.21",
 		"uuid": "^3.2.1"
@@ -58,58 +60,17 @@
 			"name": "Notifications (top-level class)",
 			"path": "./lib-esm/index.js",
 			"import": "{ Amplify, Notifications }",
-			"limit": "70.5 kB"
+			"limit": "71 kB"
 		},
 		{
 			"name": "Notifications (with Analytics)",
 			"path": "./lib-esm/index.js",
 			"import": "{ Amplify, Notifications, Analytics }",
-			"limit": "70.5 kB"
+			"limit": "71 kB"
 		}
 	],
-	"jest": {
-		"globals": {
-			"ts-jest": {
-				"diagnostics": false,
-				"tsConfig": {
-					"lib": [
-						"es5",
-						"es2015",
-						"dom",
-						"esnext.asynciterable",
-						"es2017.object"
-					],
-					"allowJs": true
-				}
-			}
-		},
-		"transform": {
-			"^.+\\.(js|jsx|ts|tsx)$": "ts-jest"
-		},
-		"testRegex": "(/__tests__/.*|\\.(test|spec))\\.(tsx?|jsx?)$",
-		"moduleFileExtensions": [
-			"ts",
-			"tsx",
-			"js",
-			"json",
-			"jsx"
-		],
-		"testEnvironment": "jsdom",
-		"testURL": "http://localhost/",
-		"coverageThreshold": {
-			"global": {
-				"branches": 0,
-				"functions": 0,
-				"lines": 0,
-				"statements": 0
-			}
-		},
-		"coveragePathIgnorePatterns": [
-			"/node_modules/",
-			"dist",
-			"lib",
-			"lib-esm"
-		]
+	"devDependencies": {
+		"@aws-amplify/rtn-push-notification": "1.0.1-unstable.1116fef.7813+1116feff6"
 	},
-	"gitHead": "4d169725f09cd910ca5a55a4fa7302a602a780fd"
+	"gitHead": "1116feff67ae991d21b77e5dd73dac66d58e8004"
 }

package/src/InAppMessaging/InAppMessaging.ts

@@ -9,29 +9,31 @@ import {
 	StorageHelper,
 } from '@aws-amplify/core';
 import flatten from 'lodash/flatten';
-import { AWSPinpointProvider } from './Providers';
+
 import {
-	addMessageInteractionEventListener,
-	notifyMessageInteractionEventListeners,
-} from './eventListeners';
+	addEventListener,
+	EventListener,
+	notifyEventListeners,
+} from '../common';
+import { UserInfo } from '../types';
+import { AWSPinpointProvider } from './Providers';
 import {
 	InAppMessage,
 	InAppMessageInteractionEvent,
+	InAppMessagingInterface,
 	InAppMessagingConfig,
 	InAppMessageConflictHandler,
 	InAppMessagingEvent,
 	InAppMessagingProvider,
-	NotificationsSubcategory,
+	NotificationsSubCategory,
 	OnMessageInteractionEventHandler,
-	OnMessageInteractionEventListener,
-	UserInfo,
 } from './types';
 
 const STORAGE_KEY_SUFFIX = '_inAppMessages';
 
 const logger = new Logger('Notifications.InAppMessaging');
 
-export default class InAppMessaging {
+export default class InAppMessaging implements InAppMessagingInterface {
 	private config: Record<string, any> = {};
 	private conflictHandler: InAppMessageConflictHandler;
 	private listeningForAnalyticEvents = false;
@@ -39,9 +41,7 @@ export default class InAppMessaging {
 	private storageSynced = false;
 
 	constructor() {
-		this.config = {
-			storage: new StorageHelper().getStorage(),
-		};
+		this.config = { storage: new StorageHelper().getStorage() };
 		this.setConflictHandler(this.defaultConflictHandler);
 	}
 
@@ -77,7 +77,7 @@ export default class InAppMessaging {
 	 * Get the name of this module
 	 * @returns {string} name of this module
 	 */
-	getModuleName(): NotificationsSubcategory {
+	getModuleName(): NotificationsSubCategory {
 		return 'InAppMessaging';
 	}
 
@@ -172,9 +172,9 @@ export default class InAppMessaging {
 		const flattenedMessages = flatten(messages);
 
 		if (flattenedMessages.length) {
-			notifyMessageInteractionEventListeners(
-				this.conflictHandler(flattenedMessages),
-				InAppMessageInteractionEvent.MESSAGE_RECEIVED
+			notifyEventListeners(
+				InAppMessageInteractionEvent.MESSAGE_RECEIVED,
+				this.conflictHandler(flattenedMessages)
 			);
 		}
 	};
@@ -193,41 +193,32 @@ export default class InAppMessaging {
 
 	onMessageReceived = (
 		handler: OnMessageInteractionEventHandler
-	): OnMessageInteractionEventListener =>
-		addMessageInteractionEventListener(
-			handler,
-			InAppMessageInteractionEvent.MESSAGE_RECEIVED
-		);
+	): EventListener<OnMessageInteractionEventHandler> =>
+		addEventListener(InAppMessageInteractionEvent.MESSAGE_RECEIVED, handler);
 
 	onMessageDisplayed = (
 		handler: OnMessageInteractionEventHandler
-	): OnMessageInteractionEventListener =>
-		addMessageInteractionEventListener(
-			handler,
-			InAppMessageInteractionEvent.MESSAGE_DISPLAYED
-		);
+	): EventListener<OnMessageInteractionEventHandler> =>
+		addEventListener(InAppMessageInteractionEvent.MESSAGE_DISPLAYED, handler);
 
 	onMessageDismissed = (
 		handler: OnMessageInteractionEventHandler
-	): OnMessageInteractionEventListener =>
-		addMessageInteractionEventListener(
-			handler,
-			InAppMessageInteractionEvent.MESSAGE_DISMISSED
-		);
+	): EventListener<OnMessageInteractionEventHandler> =>
+		addEventListener(InAppMessageInteractionEvent.MESSAGE_DISMISSED, handler);
 
 	onMessageActionTaken = (
 		handler: OnMessageInteractionEventHandler
-	): OnMessageInteractionEventListener =>
-		addMessageInteractionEventListener(
-			handler,
-			InAppMessageInteractionEvent.MESSAGE_ACTION_TAKEN
+	): EventListener<OnMessageInteractionEventHandler> =>
+		addEventListener(
+			InAppMessageInteractionEvent.MESSAGE_ACTION_TAKEN,
+			handler
 		);
 
 	notifyMessageInteraction = (
 		message: InAppMessage,
-		event: InAppMessageInteractionEvent
+		type: InAppMessageInteractionEvent
 	): void => {
-		notifyMessageInteractionEventListeners(message, event);
+		notifyEventListeners(type, message);
 	};
 
 	setConflictHandler = (handler: InAppMessageConflictHandler): void => {

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

@@ -1,27 +1,14 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import {
-	ClientDevice,
-	Credentials,
-	getAmplifyUserAgent,
-	StorageHelper,
-	transferKeyToUpperCase,
-} from '@aws-amplify/core';
-import { Cache } from '@aws-amplify/cache';
 import {
 	ChannelType,
 	GetInAppMessagesCommand,
 	GetInAppMessagesCommandInput,
 	InAppMessageCampaign as PinpointInAppMessage,
-	UpdateEndpointCommand,
-	UpdateEndpointCommandInput,
-	PinpointClient,
 } from '@aws-sdk/client-pinpoint';
-import { v4 as uuid } from 'uuid';
 
-import { addMessageInteractionEventListener } from '../../eventListeners';
-import { NotificationsCategory } from '../../../types';
+import { addEventListener, AWSPinpointProviderCommon } from '../../../common';
 import SessionTracker, {
 	SessionState,
 	SessionStateChangeHandler,
@@ -29,15 +16,12 @@ import SessionTracker, {
 import {
 	InAppMessage,
 	InAppMessageInteractionEvent,
-	InAppMessageLayout,
 	InAppMessagingEvent,
 	InAppMessagingProvider,
-	NotificationsSubcategory,
-	UserInfo,
+	NotificationsSubCategory,
 } from '../../types';
 import {
 	AWSPinpointMessageEvent,
-	AWSPinpointUserInfo,
 	DailyInAppMessageCounter,
 	InAppMessageCountMap,
 	InAppMessageCounts,
@@ -60,32 +44,19 @@ import {
 const MESSAGE_DAILY_COUNT_KEY = 'pinpointProvider_inAppMessages_dailyCount';
 const MESSAGE_TOTAL_COUNT_KEY = 'pinpointProvider_inAppMessages_totalCount';
 
-export default class AWSPinpointProvider implements InAppMessagingProvider {
-	static category: NotificationsCategory = 'Notifications';
-	static subCategory: NotificationsSubcategory = 'InAppMessaging';
-	static providerName = 'AWSPinpoint';
+export default class AWSPinpointProvider
+	extends AWSPinpointProviderCommon
+	implements InAppMessagingProvider
+{
+	static subCategory: NotificationsSubCategory = 'InAppMessaging';
 
-	private clientInfo;
-	private config: Record<string, any> = {};
 	private configured = false;
-	private endpointInitialized = false;
-	private initialized = false;
 	private sessionMessageCountMap: InAppMessageCountMap;
 	private sessionTracker: SessionTracker;
 
 	constructor() {
+		super(logger);
 		this.sessionMessageCountMap = {};
-		this.config = {
-			storage: new StorageHelper().getStorage(),
-		};
-		this.clientInfo = ClientDevice.clientInfo() ?? {};
-	}
-
-	/**
-	 * get the category of the plugin
-	 */
-	getCategory() {
-		return AWSPinpointProvider.category;
 	}
 
 	/**
@@ -95,41 +66,44 @@ export default class AWSPinpointProvider implements InAppMessagingProvider {
 		return AWSPinpointProvider.subCategory;
 	}
 
-	/**
-	 * get provider name of the plugin
-	 */
-	getProviderName(): string {
-		return AWSPinpointProvider.providerName;
-	}
-
-	configure = (config = {}): object => {
-		this.config = { ...this.config, ...config };
-
-		logger.debug('configure AWSPinpointProvider', this.config);
+	configure = (config = {}): Record<string, any> => {
+		this.config = {
+			...super.configure(config),
+			endpointInfo: { channelType: ChannelType.IN_APP },
+		};
 
 		// some configuration steps should not be re-run even if provider is re-configured for some reason
 		if (!this.configured) {
 			this.sessionTracker = new SessionTracker(this.sessionStateChangeHandler);
 			this.sessionTracker.start();
 			// wire up default Pinpoint message event handling
-			addMessageInteractionEventListener((message: InAppMessage) => {
-				this.recordMessageEvent(
-					message,
-					AWSPinpointMessageEvent.MESSAGE_DISPLAYED
-				);
-			}, InAppMessageInteractionEvent.MESSAGE_DISPLAYED);
-			addMessageInteractionEventListener((message: InAppMessage) => {
-				this.recordMessageEvent(
-					message,
-					AWSPinpointMessageEvent.MESSAGE_DISMISSED
-				);
-			}, InAppMessageInteractionEvent.MESSAGE_DISMISSED);
-			addMessageInteractionEventListener((message: InAppMessage) => {
-				this.recordMessageEvent(
-					message,
-					AWSPinpointMessageEvent.MESSAGE_ACTION_TAKEN
-				);
-			}, InAppMessageInteractionEvent.MESSAGE_ACTION_TAKEN);
+			addEventListener(
+				InAppMessageInteractionEvent.MESSAGE_DISPLAYED,
+				(message: InAppMessage) => {
+					this.recordMessageEvent(
+						message,
+						AWSPinpointMessageEvent.MESSAGE_DISPLAYED
+					);
+				}
+			);
+			addEventListener(
+				InAppMessageInteractionEvent.MESSAGE_DISMISSED,
+				(message: InAppMessage) => {
+					this.recordMessageEvent(
+						message,
+						AWSPinpointMessageEvent.MESSAGE_DISMISSED
+					);
+				}
+			);
+			addEventListener(
+				InAppMessageInteractionEvent.MESSAGE_ACTION_TAKEN,
+				(message: InAppMessage) => {
+					this.recordMessageEvent(
+						message,
+						AWSPinpointMessageEvent.MESSAGE_ACTION_TAKEN
+					);
+				}
+			);
 		}
 
 		this.configured = true;
@@ -155,14 +129,14 @@ export default class AWSPinpointProvider implements InAppMessagingProvider {
 			const command: GetInAppMessagesCommand = new GetInAppMessagesCommand(
 				input
 			);
-			logger.debug('getting in-app messages', input);
+			this.logger.debug('getting in-app messages');
 			const response = await pinpointClient.send(command);
 			const { InAppMessageCampaigns: messages } =
 				response.InAppMessagesResponse;
 			dispatchInAppMessagingEvent('getInAppMessages', messages);
 			return messages;
 		} catch (err) {
-			logger.error('Error getting in-app messages', err);
+			this.logger.error('Error getting in-app messages', err);
 			throw err;
 		}
 	};
@@ -212,180 +186,6 @@ export default class AWSPinpointProvider implements InAppMessagingProvider {
 		);
 	};
 
-	identifyUser = async (userId: string, userInfo: UserInfo): Promise<void> => {
-		if (!this.initialized) {
-			await this.init();
-		}
-		try {
-			await this.updateEndpoint(userId, userInfo);
-		} catch (err) {
-			logger.error('Error identifying user', err);
-			throw err;
-		}
-	};
-
-	private init = async () => {
-		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) {
-			logger.error(`Failed to initialize ${providerName}`, err);
-		}
-	};
-
-	private initPinpointClient = async () => {
-		const { appId, credentials, pinpointClient, region } = this.config;
-
-		if (!appId || !credentials || !region) {
-			throw new Error(
-				'One or more of credentials, appId or region is not configured'
-			);
-		}
-
-		if (pinpointClient) {
-			pinpointClient.destroy();
-		}
-
-		this.config.pinpointClient = new PinpointClient({
-			region,
-			credentials,
-			customUserAgent: getAmplifyUserAgent(),
-		});
-	};
-
-	private getEndpointId = async () => {
-		const { appId } = this.config;
-		// Each Pinpoint channel requires its own Endpoint ID
-		const cacheKey = `${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 = uuid();
-		// 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 updateEndpoint = async (
-		userId: string = null,
-		userInfo: AWSPinpointUserInfo = null
-	) => {
-		const {
-			appId,
-			credentials,
-			endpointId,
-			endpointInfo = {},
-			pinpointClient,
-		} = this.config;
-		const currentCredentials = await this.getCredentials();
-		// Shallow compare to determine if credentials stored here are outdated
-		const credentialsUpdated =
-			!credentials ||
-			Object.keys(currentCredentials).some(
-				key => currentCredentials[key] !== 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 = currentCredentials;
-		try {
-			// Initialize a new pinpoint client if one isn't already configured or if credentials changed
-			if (!pinpointClient || credentialsUpdated) {
-				await this.initPinpointClient();
-			}
-			const { address, attributes, demographic, location, metrics, optOut } =
-				userInfo ?? {};
-			const { appVersion, make, model, platform, version } = this.clientInfo;
-			// Create the UpdateEndpoint input, prioritizing passed in user info and falling back to
-			// defaults (if any) obtained from the config
-			const input: UpdateEndpointCommandInput = {
-				ApplicationId: appId,
-				EndpointId: endpointId,
-				EndpointRequest: {
-					RequestId: uuid(),
-					EffectiveDate: new Date().toISOString(),
-					ChannelType: ChannelType.IN_APP,
-					Address: address ?? endpointInfo.address,
-					Attributes: {
-						...endpointInfo.attributes,
-						...attributes,
-					},
-					Demographic: {
-						AppVersion: appVersion,
-						Make: make,
-						Model: model,
-						ModelVersion: version,
-						Platform: platform,
-						...transferKeyToUpperCase({
-							...endpointInfo.demographic,
-							...demographic,
-						}),
-					},
-					Location: transferKeyToUpperCase({
-						...endpointInfo.location,
-						...location,
-					}),
-					Metrics: {
-						...endpointInfo.metrics,
-						...metrics,
-					},
-					OptOut: optOut ?? endpointInfo.optOut,
-					User: {
-						UserId:
-							userId ?? endpointInfo.userId ?? currentCredentials.identityId,
-						UserAttributes: attributes ?? endpointInfo.userAttributes,
-					},
-				},
-			};
-			const command: UpdateEndpointCommand = new UpdateEndpointCommand(input);
-			logger.debug('updating endpoint', input);
-			await this.config.pinpointClient.send(command);
-			this.endpointInitialized = true;
-		} catch (err) {
-			throw err;
-		}
-	};
-
-	private getCredentials = async () => {
-		try {
-			const credentials = await Credentials.get();
-			if (!credentials) {
-				logger.debug('no credentials found');
-				return null;
-			}
-			return Credentials.shear(credentials);
-		} catch (err) {
-			logger.error('Error getting credentials:', err);
-			return null;
-		}
-	};
-
 	private sessionStateChangeHandler: SessionStateChangeHandler = (
 		state: SessionState
 	) => {
@@ -447,7 +247,7 @@ export default class AWSPinpointProvider implements InAppMessagingProvider {
 				totalCount: this.getTotalCount(messageId),
 			};
 		} catch (err) {
-			logger.error('Failed to get message counts from storage', err);
+			this.logger.error('Failed to get message counts from storage', err);
 		}
 	};
 
@@ -464,7 +264,7 @@ export default class AWSPinpointProvider implements InAppMessagingProvider {
 		try {
 			storage.setItem(MESSAGE_DAILY_COUNT_KEY, JSON.stringify(dailyCount));
 		} catch (err) {
-			logger.error('Failed to save daily message count to storage', err);
+			this.logger.error('Failed to save daily message count to storage', err);
 		}
 	};
 
@@ -473,7 +273,7 @@ export default class AWSPinpointProvider implements InAppMessagingProvider {
 		try {
 			storage.setItem(MESSAGE_TOTAL_COUNT_KEY, JSON.stringify(countMap));
 		} catch (err) {
-			logger.error('Failed to save total count to storage', err);
+			this.logger.error('Failed to save total count to storage', err);
 		}
 	};
 

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

@@ -1,8 +1,6 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { UserInfo } from '../../types';
-
 export type InAppMessageCountMap = Record<string, number>;
 
 export type DailyInAppMessageCounter = {
@@ -21,18 +19,8 @@ export type MetricsComparator = (
 	eventVal: number
 ) => boolean;
 
-export interface AWSPinpointProviderConfig {
-	appId: string;
-	region: string;
-}
-
 export enum AWSPinpointMessageEvent {
 	MESSAGE_DISPLAYED = '_inapp.message_displayed',
 	MESSAGE_DISMISSED = '_inapp.message_dismissed',
 	MESSAGE_ACTION_TAKEN = '_inapp.message_clicked',
 }
-
-export interface AWSPinpointUserInfo extends UserInfo {
-	address?: string;
-	optOut?: 'ALL' | 'NONE';
-}

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

@@ -7,6 +7,7 @@ import {
 	Layout as PinpointInAppMessageLayout,
 } from '@aws-sdk/client-pinpoint';
 import isEmpty from 'lodash/isEmpty';
+import { AMPLIFY_SYMBOL } from '../../../common';
 import {
 	InAppMessage,
 	InAppMessageAction,
@@ -15,20 +16,16 @@ import {
 	InAppMessageTextAlign,
 	InAppMessagingEvent,
 } from '../../types';
+
 import { AWSPinpointMessageEvent, MetricsComparator } from './types';
 
-const AMPLIFY_SYMBOL = (
-	typeof Symbol !== 'undefined' && typeof Symbol.for === 'function'
-		? Symbol.for('amplify_default')
-		: '@@amplify_default'
-) as Symbol;
 const DELIVERY_TYPE = 'IN_APP_MESSAGE';
 
 let eventNameMemo = {};
 let eventAttributesMemo = {};
 let eventMetricsMemo = {};
 
-export const logger = new ConsoleLogger('AWSPinpointProvider');
+export const logger = new ConsoleLogger('InAppMessaging.AWSPinpointProvider');
 
 export const dispatchInAppMessagingEvent = (
 	event: string,
@@ -47,12 +44,6 @@ export const recordAnalyticsEvent = (
 	event: AWSPinpointMessageEvent,
 	message: InAppMessage
 ) => {
-	if (!message) {
-		logger.debug(
-			'Unable to record analytics event - no InAppMessage was received'
-		);
-		return;
-	}
 	if (Amplify.Analytics && typeof Amplify.Analytics.record === 'function') {
 		const { id, metadata } = message;
 		Amplify.Analytics.record({

package/src/InAppMessaging/index.ts

@@ -2,8 +2,6 @@
 // SPDX-License-Identifier: Apache-2.0
 
 export { default } from './InAppMessaging';
-export { AWSPinpointProvider } from './Providers';
-export { AWSPinpointUserInfo } from './Providers/AWSPinpointProvider/types';
 export {
 	InAppMessage,
 	InAppMessageAction,
@@ -16,5 +14,4 @@ export {
 	InAppMessageTextAlign,
 	InAppMessagingConfig,
 	InAppMessagingEvent,
-	UserInfo,
 } from './types';