@aws-amplify/notifications 0.0.2-unstable.7462

package/lib-esm/Notifications.d.ts

@@ -0,0 +1,20 @@
+import InAppMessaging from './InAppMessaging';
+import { NotificationsCategory, NotificationsConfig } from './types';
+declare class NotificationsClass {
+    private config;
+    private inAppMessaging;
+    constructor();
+    /**
+     * Get the name of the module category
+     * @returns {string} name of the module category
+     */
+    getModuleName(): NotificationsCategory;
+    /**
+     * Configure Notifications
+     * @param {Object} config - Notifications configuration object
+     */
+    configure: ({ Notifications: config }?: NotificationsConfig) => Record<string, any>;
+    get InAppMessaging(): InAppMessaging;
+}
+declare const Notifications: NotificationsClass;
+export default Notifications;

package/lib-esm/Notifications.js

@@ -0,0 +1,44 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { __assign } from "tslib";
+import { Amplify, ConsoleLogger as Logger } from '@aws-amplify/core';
+import InAppMessaging from './InAppMessaging';
+var logger = new Logger('Notifications');
+var NotificationsClass = /** @class */ (function () {
+    function NotificationsClass() {
+        var _this = this;
+        this.config = {};
+        /**
+         * Configure Notifications
+         * @param {Object} config - Notifications configuration object
+         */
+        this.configure = function (_a) {
+            var config = (_a === void 0 ? {} : _a).Notifications;
+            _this.config = __assign(__assign({}, _this.config), config);
+            logger.debug('configure Notifications', config);
+            // Configure sub-categories
+            _this.inAppMessaging.configure(_this.config.InAppMessaging);
+            return _this.config;
+        };
+        this.inAppMessaging = new InAppMessaging();
+    }
+    /**
+     * Get the name of the module category
+     * @returns {string} name of the module category
+     */
+    NotificationsClass.prototype.getModuleName = function () {
+        return 'Notifications';
+    };
+    Object.defineProperty(NotificationsClass.prototype, "InAppMessaging", {
+        get: function () {
+            return this.inAppMessaging;
+        },
+        enumerable: true,
+        configurable: true
+    });
+    return NotificationsClass;
+}());
+var Notifications = new NotificationsClass();
+export default Notifications;
+Amplify.register(Notifications);
+//# sourceMappingURL=Notifications.js.map

package/lib-esm/Notifications.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Notifications.js","sourceRoot":"","sources":["../src/Notifications.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC;;AAEtC,OAAO,EAAE,OAAO,EAAE,aAAa,IAAI,MAAM,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAG9C,IAAM,MAAM,GAAG,IAAI,MAAM,CAAC,eAAe,CAAC,CAAC;AAE3C;IAIC;QAAA,iBAEC;QALO,WAAM,GAAwB,EAAE,CAAC;QAezC;;;WAGG;QACH,cAAS,GAAG,UAAC,EAAmD;gBAAjD,gDAAqB;YACnC,KAAI,CAAC,MAAM,yBAAQ,KAAI,CAAC,MAAM,GAAK,MAAM,CAAE,CAAC;YAE5C,MAAM,CAAC,KAAK,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC;YAEhD,2BAA2B;YAC3B,KAAI,CAAC,cAAc,CAAC,SAAS,CAAC,KAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;YAE1D,OAAO,KAAI,CAAC,MAAM,CAAC;QACpB,CAAC,CAAC;QAxBD,IAAI,CAAC,cAAc,GAAG,IAAI,cAAc,EAAE,CAAC;IAC5C,CAAC;IAED;;;OAGG;IACH,0CAAa,GAAb;QACC,OAAO,eAAe,CAAC;IACxB,CAAC;IAiBD,sBAAI,8CAAc;aAAlB;YACC,OAAO,IAAI,CAAC,cAAc,CAAC;QAC5B,CAAC;;;OAAA;IACF,yBAAC;AAAD,CAAC,AAlCD,IAkCC;AAED,IAAM,aAAa,GAAG,IAAI,kBAAkB,EAAE,CAAC;AAE/C,eAAe,aAAa,CAAC;AAC7B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC"}

package/lib-esm/index.d.ts

@@ -0,0 +1,3 @@
+export { default as Notifications } from './Notifications';
+export { AWSPinpointUserInfo, InAppMessage, InAppMessageAction, InAppMessageButton, InAppMessageContent, InAppMessageImage, InAppMessageInteractionEvent, InAppMessageLayout, InAppMessageStyle, InAppMessageTextAlign, InAppMessagingConfig, InAppMessagingEvent, UserInfo, } from './InAppMessaging';
+export { NotificationsConfig } from './types';

package/lib-esm/index.js

@@ -0,0 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export { default as Notifications } from './Notifications';
+export { InAppMessageInteractionEvent, } from './InAppMessaging';
+//# sourceMappingURL=index.js.map

package/lib-esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC;AAEtC,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAON,4BAA4B,GAO5B,MAAM,kBAAkB,CAAC"}

package/lib-esm/types.d.ts

@@ -0,0 +1,7 @@
+import { InAppMessagingConfig } from './InAppMessaging';
+export declare type NotificationsCategory = 'Notifications';
+export interface NotificationsConfig extends Record<any, any> {
+    Notifications?: {
+        InAppMessaging?: InAppMessagingConfig;
+    };
+}

package/lib-esm/types.js

@@ -0,0 +1 @@
+//# sourceMappingURL=types.js.map

package/lib-esm/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,99 @@
+{
+	"name": "@aws-amplify/notifications",
+	"version": "0.0.2-unstable.7462+751349a34",
+	"description": "Notifications category of aws-amplify",
+	"main": "./lib/index.js",
+	"module": "./lib-esm/index.js",
+	"typings": "./lib-esm/index.d.ts",
+	"sideEffects": [
+		"./lib/Notifications.js",
+		"./lib-esm/Notifications.js"
+	],
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"test": "tslint 'src/**/*.ts' && jest -w 1 --coverage",
+		"test:watch": "tslint 'src/**/*.ts' && jest -w 1 --watch",
+		"build-with-test": "npm run clean && npm test && tsc && webpack",
+		"build:cjs": "node ./build es5 && webpack && webpack --config ./webpack.config.dev.js",
+		"build:esm": "node ./build es6",
+		"build:cjs:watch": "node ./build es5 --watch",
+		"build:esm:watch": "node ./build es6 --watch",
+		"build": "npm run clean && npm run build:esm && npm run build:cjs",
+		"clean": "rimraf lib-esm lib dist",
+		"format": "echo \"Not implemented\"",
+		"lint": "tslint 'src/**/*.ts' && npm run ts-coverage",
+		"ts-coverage": "typescript-coverage-report -p ./tsconfig.build.json -t 88.21"
+	},
+	"react-native": {
+		"./lib/index": "./lib-esm/index.js"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/aws-amplify/amplify-js.git"
+	},
+	"author": "Amazon Web Services",
+	"license": "Apache-2.0",
+	"bugs": {
+		"url": "https://github.com/aws/aws-amplify/issues"
+	},
+	"homepage": "https://docs.amplify.aws/",
+	"files": [
+		"lib",
+		"lib-esm",
+		"src"
+	],
+	"dependencies": {
+		"@aws-amplify/cache": "4.0.64-unstable.4+751349a34",
+		"@aws-amplify/core": "4.7.13-unstable.4+751349a34",
+		"@aws-sdk/client-pinpoint": "3.186.0",
+		"lodash": "^4.17.21",
+		"uuid": "^3.2.1"
+	},
+	"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"
+		]
+	},
+	"gitHead": "751349a340e10c0dded302db94bc5c2095f5651a"
+}

package/src/InAppMessaging/InAppMessaging.ts

@@ -0,0 +1,330 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	ConsoleLogger as Logger,
+	HubCallback,
+	HubCapsule,
+	Hub,
+	StorageHelper,
+} from '@aws-amplify/core';
+import flatten from 'lodash/flatten';
+import { AWSPinpointProvider } from './Providers';
+import {
+	addMessageInteractionEventListener,
+	notifyMessageInteractionEventListeners,
+} from './eventListeners';
+import {
+	InAppMessage,
+	InAppMessageInteractionEvent,
+	InAppMessagingConfig,
+	InAppMessageConflictHandler,
+	InAppMessagingEvent,
+	InAppMessagingProvider,
+	NotificationsSubcategory,
+	OnMessageInteractionEventHandler,
+	OnMessageInteractionEventListener,
+	UserInfo,
+} from './types';
+
+const STORAGE_KEY_SUFFIX = '_inAppMessages';
+
+const logger = new Logger('Notifications.InAppMessaging');
+
+export default class InAppMessaging {
+	private config: Record<string, any> = {};
+	private conflictHandler: InAppMessageConflictHandler;
+	private listeningForAnalyticEvents = false;
+	private pluggables: InAppMessagingProvider[] = [];
+	private storageSynced = false;
+
+	constructor() {
+		this.config = {
+			storage: new StorageHelper().getStorage(),
+		};
+		this.setConflictHandler(this.defaultConflictHandler);
+	}
+
+	/**
+	 * Configure InAppMessaging
+	 * @param {Object} config - InAppMessaging configuration object
+	 */
+	configure = ({
+		listenForAnalyticsEvents = true,
+		...config
+	}: InAppMessagingConfig = {}): InAppMessagingConfig => {
+		this.config = { ...this.config, ...config };
+
+		logger.debug('configure InAppMessaging', this.config);
+
+		this.pluggables.forEach(pluggable => {
+			pluggable.configure(this.config[pluggable.getProviderName()]);
+		});
+
+		if (this.pluggables.length === 0) {
+			this.addPluggable(new AWSPinpointProvider());
+		}
+
+		if (listenForAnalyticsEvents && !this.listeningForAnalyticEvents) {
+			Hub.listen('analytics', this.analyticsListener);
+			this.listeningForAnalyticEvents = true;
+		}
+
+		return this.config;
+	};
+
+	/**
+	 * Get the name of this module
+	 * @returns {string} name of this module
+	 */
+	getModuleName(): NotificationsSubcategory {
+		return 'InAppMessaging';
+	}
+
+	/**
+	 * Get a plugin from added plugins
+	 * @param {string} providerName - the name of the plugin to get
+	 */
+	getPluggable = (providerName: string): InAppMessagingProvider => {
+		const pluggable =
+			this.pluggables.find(
+				pluggable => pluggable.getProviderName() === providerName
+			) ?? null;
+
+		if (!pluggable) {
+			logger.debug(`No plugin found with name ${providerName}`);
+		}
+
+		return pluggable;
+	};
+
+	/**
+	 * Add plugin into InAppMessaging
+	 * @param {InAppMessagingProvider} pluggable - an instance of the plugin
+	 */
+	addPluggable = (pluggable: InAppMessagingProvider): void => {
+		if (
+			pluggable &&
+			pluggable.getCategory() === 'Notifications' &&
+			pluggable.getSubCategory() === 'InAppMessaging'
+		) {
+			if (this.getPluggable(pluggable.getProviderName())) {
+				throw new Error(
+					`Pluggable ${pluggable.getProviderName()} has already been added.`
+				);
+			}
+			this.pluggables.push(pluggable);
+			pluggable.configure(this.config[pluggable.getProviderName()]);
+		}
+	};
+
+	/**
+	 * Remove a plugin from added plugins
+	 * @param {string} providerName - the name of the plugin to remove
+	 */
+	removePluggable = (providerName: string): void => {
+		const index = this.pluggables.findIndex(
+			pluggable => pluggable.getProviderName() === providerName
+		);
+		if (index === -1) {
+			logger.debug(`No plugin found with name ${providerName}`);
+		} else {
+			this.pluggables.splice(index, 1);
+		}
+	};
+
+	/**
+	 * Get the map resources that are currently available through the provider
+	 * @param {string} provider
+	 * @returns - Array of available map resources
+	 */
+	syncMessages = (): Promise<void[]> =>
+		Promise.all<void>(
+			this.pluggables.map(async pluggable => {
+				try {
+					const messages = await pluggable.getInAppMessages();
+					const key = `${pluggable.getProviderName()}${STORAGE_KEY_SUFFIX}`;
+					await this.setMessages(key, messages);
+				} catch (err) {
+					logger.error('Failed to sync messages', err);
+					throw err;
+				}
+			})
+		);
+
+	clearMessages = (): Promise<void[]> =>
+		Promise.all<void>(
+			this.pluggables.map(async pluggable => {
+				const key = `${pluggable.getProviderName()}${STORAGE_KEY_SUFFIX}`;
+				await this.removeMessages(key);
+			})
+		);
+
+	dispatchEvent = async (event: InAppMessagingEvent): Promise<void> => {
+		const messages: InAppMessage[][] = await Promise.all<InAppMessage[]>(
+			this.pluggables.map(async pluggable => {
+				const key = `${pluggable.getProviderName()}${STORAGE_KEY_SUFFIX}`;
+				const messages = await this.getMessages(key);
+				return pluggable.processInAppMessages(messages, event);
+			})
+		);
+
+		const flattenedMessages = flatten(messages);
+
+		if (flattenedMessages.length) {
+			notifyMessageInteractionEventListeners(
+				this.conflictHandler(flattenedMessages),
+				InAppMessageInteractionEvent.MESSAGE_RECEIVED
+			);
+		}
+	};
+
+	identifyUser = (userId: string, userInfo: UserInfo): Promise<void[]> =>
+		Promise.all<void>(
+			this.pluggables.map(async pluggable => {
+				try {
+					await pluggable.identifyUser(userId, userInfo);
+				} catch (err) {
+					logger.error('Failed to identify user', err);
+					throw err;
+				}
+			})
+		);
+
+	onMessageReceived = (
+		handler: OnMessageInteractionEventHandler
+	): OnMessageInteractionEventListener =>
+		addMessageInteractionEventListener(
+			handler,
+			InAppMessageInteractionEvent.MESSAGE_RECEIVED
+		);
+
+	onMessageDisplayed = (
+		handler: OnMessageInteractionEventHandler
+	): OnMessageInteractionEventListener =>
+		addMessageInteractionEventListener(
+			handler,
+			InAppMessageInteractionEvent.MESSAGE_DISPLAYED
+		);
+
+	onMessageDismissed = (
+		handler: OnMessageInteractionEventHandler
+	): OnMessageInteractionEventListener =>
+		addMessageInteractionEventListener(
+			handler,
+			InAppMessageInteractionEvent.MESSAGE_DISMISSED
+		);
+
+	onMessageActionTaken = (
+		handler: OnMessageInteractionEventHandler
+	): OnMessageInteractionEventListener =>
+		addMessageInteractionEventListener(
+			handler,
+			InAppMessageInteractionEvent.MESSAGE_ACTION_TAKEN
+		);
+
+	notifyMessageInteraction = (
+		message: InAppMessage,
+		event: InAppMessageInteractionEvent
+	): void => {
+		notifyMessageInteractionEventListeners(message, event);
+	};
+
+	setConflictHandler = (handler: InAppMessageConflictHandler): void => {
+		this.conflictHandler = handler;
+	};
+
+	private analyticsListener: HubCallback = ({ payload }: HubCapsule) => {
+		const { event, data } = payload;
+		switch (event) {
+			case 'record': {
+				this.dispatchEvent(data);
+				break;
+			}
+			default:
+				break;
+		}
+	};
+
+	private syncStorage = async (): Promise<void> => {
+		const { storage } = this.config;
+		try {
+			// Only run sync() if it's available (i.e. React Native)
+			if (typeof storage.sync === 'function') {
+				await storage.sync();
+			}
+			this.storageSynced = true;
+		} catch (err) {
+			logger.error('Failed to sync storage', err);
+		}
+	};
+
+	private getMessages = async (key: string): Promise<any> => {
+		try {
+			if (!this.storageSynced) {
+				await this.syncStorage();
+			}
+			const { storage } = this.config;
+			const storedMessages = storage.getItem(key);
+			return storedMessages ? JSON.parse(storedMessages) : [];
+		} catch (err) {
+			logger.error('Failed to retrieve in-app messages from storage', err);
+		}
+	};
+
+	private setMessages = async (
+		key: string,
+		messages: InAppMessage[]
+	): Promise<void> => {
+		if (!messages) {
+			return;
+		}
+
+		try {
+			if (!this.storageSynced) {
+				await this.syncStorage();
+			}
+			const { storage } = this.config;
+			storage.setItem(key, JSON.stringify(messages));
+		} catch (err) {
+			logger.error('Failed to store in-app messages', err);
+		}
+	};
+
+	private removeMessages = async (key: string): Promise<void> => {
+		try {
+			if (!this.storageSynced) {
+				await this.syncStorage();
+			}
+			const { storage } = this.config;
+			storage.removeItem(key);
+		} catch (err) {
+			logger.error('Failed to remove in-app messages from storage', err);
+		}
+	};
+
+	private defaultConflictHandler = (messages: InAppMessage[]): InAppMessage => {
+		// default behavior is to return the message closest to expiry
+		// this function assumes that messages processed by providers already filters out expired messages
+		const sorted = messages.sort((a, b) => {
+			const endDateA = a.metadata?.endDate;
+			const endDateB = b.metadata?.endDate;
+			// if both message end dates are falsy or have the same date string, treat them as equal
+			if (endDateA === endDateB) {
+				return 0;
+			}
+			// if only message A has an end date, treat it as closer to expiry
+			if (endDateA && !endDateB) {
+				return -1;
+			}
+			// if only message B has an end date, treat it as closer to expiry
+			if (!endDateA && endDateB) {
+				return 1;
+			}
+			// otherwise, compare them
+			return new Date(endDateA) < new Date(endDateB) ? -1 : 1;
+		});
+		// always return the top sorted
+		return sorted[0];
+	};
+}