@aws-amplify/notifications 1.0.25 → 1.0.26-unstable.1b5840e.8

package/lib-esm/PushNotification/PushNotification.js

@@ -0,0 +1,89 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { __awaiter, __generator } from "tslib";
+import PlatformNotSupportedError from './PlatformNotSupportedError';
+var PushNotification = /** @class */ (function () {
+    function PushNotification() {
+        var _this = this;
+        /**
+         * Configure PushNotification
+         * @param {Object} config - PushNotification configuration object
+         */
+        this.configure = function (_) {
+            if (_ === void 0) { _ = {}; }
+            throw new PlatformNotSupportedError();
+        };
+        /**
+         * Get a plugin from added plugins
+         * @param {string} providerName - the name of the plugin to get
+         */
+        this.getPluggable = function (_) {
+            throw new PlatformNotSupportedError();
+        };
+        /**
+         * Add plugin into PushNotification
+         * @param {PushNotificationProvider} pluggable - an instance of the plugin
+         */
+        this.addPluggable = function (_) {
+            throw new PlatformNotSupportedError();
+        };
+        /**
+         * Remove a plugin from added plugins
+         * @param {string} providerName - the name of the plugin to remove
+         */
+        this.removePluggable = function () {
+            throw new PlatformNotSupportedError();
+        };
+        this.enable = function () {
+            throw new PlatformNotSupportedError();
+        };
+        this.identifyUser = function () {
+            throw new PlatformNotSupportedError();
+        };
+        this.getLaunchNotification = function () { return __awaiter(_this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                throw new PlatformNotSupportedError();
+            });
+        }); };
+        this.getBadgeCount = function () { return __awaiter(_this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                throw new PlatformNotSupportedError();
+            });
+        }); };
+        this.setBadgeCount = function (_) {
+            throw new PlatformNotSupportedError();
+        };
+        this.getPermissionStatus = function () { return __awaiter(_this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                throw new PlatformNotSupportedError();
+            });
+        }); };
+        this.requestPermissions = function (_) { return __awaiter(_this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                throw new PlatformNotSupportedError();
+            });
+        }); };
+        this.onNotificationReceivedInBackground = function (_) {
+            throw new PlatformNotSupportedError();
+        };
+        this.onNotificationReceivedInForeground = function (_) {
+            throw new PlatformNotSupportedError();
+        };
+        this.onTokenReceived = function (_) {
+            throw new PlatformNotSupportedError();
+        };
+        this.onNotificationOpened = function (_) {
+            throw new PlatformNotSupportedError();
+        };
+    }
+    /**
+     * Get the name of this module
+     * @returns {string} name of this module
+     */
+    PushNotification.prototype.getModuleName = function () {
+        throw new PlatformNotSupportedError();
+    };
+    return PushNotification;
+}());
+export default PushNotification;
+//# sourceMappingURL=PushNotification.js.map

package/lib-esm/PushNotification/PushNotification.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PushNotification.js","sourceRoot":"","sources":["../../src/PushNotification/PushNotification.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC;;AAEtC,OAAO,yBAAyB,MAAM,6BAA6B,CAAC;AAapE;IAAA;QAAA,iBA0FC;QAzFA;;;WAGG;QACH,cAAS,GAAG,UAAC,CAA8B;YAA9B,kBAAA,EAAA,MAA8B;YAC1C,MAAM,IAAI,yBAAyB,EAAE,CAAC;QACvC,CAAC,CAAC;QAUF;;;WAGG;QACH,iBAAY,GAAG,UAAC,CAAS;YACxB,MAAM,IAAI,yBAAyB,EAAE,CAAC;QACvC,CAAC,CAAC;QAEF;;;WAGG;QACH,iBAAY,GAAG,UAAC,CAA2B;YAC1C,MAAM,IAAI,yBAAyB,EAAE,CAAC;QACvC,CAAC,CAAC;QAEF;;;WAGG;QACH,oBAAe,GAAG;YACjB,MAAM,IAAI,yBAAyB,EAAE,CAAC;QACvC,CAAC,CAAC;QAEF,WAAM,GAAG;YACR,MAAM,IAAI,yBAAyB,EAAE,CAAC;QACvC,CAAC,CAAC;QAEF,iBAAY,GAAG;YACd,MAAM,IAAI,yBAAyB,EAAE,CAAC;QACvC,CAAC,CAAC;QAEF,0BAAqB,GAAG;;gBACvB,MAAM,IAAI,yBAAyB,EAAE,CAAC;;aACtC,CAAC;QAEF,kBAAa,GAAG;;gBACf,MAAM,IAAI,yBAAyB,EAAE,CAAC;;aACtC,CAAC;QAEF,kBAAa,GAAG,UAAC,CAAS;YACzB,MAAM,IAAI,yBAAyB,EAAE,CAAC;QACvC,CAAC,CAAC;QAEF,wBAAmB,GAAG;;gBACrB,MAAM,IAAI,yBAAyB,EAAE,CAAC;;aACtC,CAAC;QAEF,uBAAkB,GAAG,UACpB,CAA+B;;gBAE/B,MAAM,IAAI,yBAAyB,EAAE,CAAC;;aACtC,CAAC;QAEF,uCAAkC,GAAG,UACpC,CAAmC;YAEnC,MAAM,IAAI,yBAAyB,EAAE,CAAC;QACvC,CAAC,CAAC;QAEF,uCAAkC,GAAG,UACpC,CAAmC;YAEnC,MAAM,IAAI,yBAAyB,EAAE,CAAC;QACvC,CAAC,CAAC;QAEF,oBAAe,GAAG,UAAC,CAAyB;YAC3C,MAAM,IAAI,yBAAyB,EAAE,CAAC;QACvC,CAAC,CAAC;QAEF,yBAAoB,GAAG,UAAC,CAAmC;YAC1D,MAAM,IAAI,yBAAyB,EAAE,CAAC;QACvC,CAAC,CAAC;IACH,CAAC;IAjFA;;;OAGG;IACH,wCAAa,GAAb;QACC,MAAM,IAAI,yBAAyB,EAAE,CAAC;IACvC,CAAC;IA2EF,uBAAC;AAAD,CAAC,AA1FD,IA0FC"}

package/lib-esm/PushNotification/PushNotification.native.d.ts

@@ -0,0 +1,63 @@
+import { EventListener } from '../common';
+import { UserInfo } from '../types';
+import { NotificationsSubCategory, OnPushNotificationMessageHandler, OnTokenReceivedHandler, PushNotificationConfig, PushNotificationInterface, PushNotificationMessage, PushNotificationPermissions, PushNotificationPermissionStatus, PushNotificationProvider } from './types';
+export default class PushNotification implements PushNotificationInterface {
+    private isEnabled;
+    private config;
+    private nativeEvent;
+    private nativeEventEmitter;
+    private nativeHeadlessTaskKey;
+    private nativeModule;
+    private pluggables;
+    private token;
+    constructor();
+    /**
+     * Configure PushNotification
+     * @param {Object} config - PushNotification configuration object
+     */
+    configure: (config?: PushNotificationConfig) => PushNotificationConfig;
+    /**
+     * Get the name of this module
+     * @returns {string} name of this module
+     */
+    getModuleName(): NotificationsSubCategory;
+    /**
+     * Get a plugin from added plugins
+     * @param {string} providerName - the name of the plugin to get
+     */
+    getPluggable: (providerName: string) => PushNotificationProvider;
+    /**
+     * Add plugin into PushNotification
+     * @param {PushNotificationProvider} pluggable - an instance of the plugin
+     */
+    addPluggable: (pluggable: PushNotificationProvider) => void;
+    /**
+     * Remove a plugin from added plugins
+     * @param {string} providerName - the name of the plugin to remove
+     */
+    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>;
+    /**
+     * Background notifications on will start the app (as a headless JS instance running on a background service on
+     * Android) in the background. Handlers registered via `onNotificationReceivedInBackground` should return Promises if
+     * it needs to be asynchronous (e.g. to perform some network requests). The app should run in the background as long
+     * as there are handlers still running (however, if they run for more than 30 seconds on iOS, subsequent tasks could
+     * get deprioritized!). If it is necessary for a handler to execute while the app is in quit state, it should be
+     * registered in the application entry point (e.g. index.js) since the application will not fully mount in that case.
+     *
+     * @param handler a function to be run when a BACKGROUND_MESSAGE_RECEIVED event is received
+     * @returns an event listener which should be removed when no longer needed
+     */
+    onNotificationReceivedInBackground: (handler: OnPushNotificationMessageHandler) => EventListener<OnPushNotificationMessageHandler>;
+    onNotificationReceivedInForeground: (handler: OnPushNotificationMessageHandler) => EventListener<OnPushNotificationMessageHandler>;
+    onNotificationOpened: (handler: OnPushNotificationMessageHandler) => EventListener<OnPushNotificationMessageHandler>;
+    onTokenReceived: (handler: OnTokenReceivedHandler) => EventListener<OnTokenReceivedHandler>;
+    private registerDevice;
+    private assertIsEnabled;
+}

package/lib-esm/PushNotification/PushNotification.native.js

@@ -0,0 +1,325 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { __assign, __awaiter, __generator } from "tslib";
+import { AppRegistry, NativeEventEmitter } from 'react-native';
+import { ConsoleLogger as Logger } from '@aws-amplify/core';
+import { AmplifyRTNPushNotification, } from '@aws-amplify/rtn-push-notification';
+import { addEventListener, notifyEventListeners, notifyEventListenersAndAwaitHandlers, } from '../common';
+import NotEnabledError from './NotEnabledError';
+import { AWSPinpointProvider } from './Providers';
+import { normalizeNativePermissionStatus, normalizeNativeMessage, } from './utils';
+var logger = new Logger('Notifications.PushNotification');
+var RTN_MODULE = '@aws-amplify/rtn-push-notification';
+var BACKGROUND_TASK_TIMEOUT = 25; // seconds
+var PushNotification = /** @class */ (function () {
+    function PushNotification() {
+        var _this = this;
+        this.isEnabled = false;
+        this.config = {};
+        this.pluggables = [];
+        /**
+         * Configure PushNotification
+         * @param {Object} config - PushNotification configuration object
+         */
+        this.configure = function (config) {
+            if (config === void 0) { config = {}; }
+            _this.config = __assign(__assign({}, _this.config), config);
+            logger.debug('configure PushNotification', _this.config);
+            _this.pluggables.forEach(function (pluggable) {
+                pluggable.configure(_this.config[pluggable.getProviderName()]);
+            });
+            if (_this.pluggables.length === 0) {
+                _this.addPluggable(new AWSPinpointProvider());
+            }
+            return _this.config;
+        };
+        /**
+         * Get a plugin from added plugins
+         * @param {string} providerName - the name of the plugin to get
+         */
+        this.getPluggable = function (providerName) {
+            var _a;
+            var pluggable = (_a = _this.pluggables.find(function (pluggable) { return pluggable.getProviderName() === providerName; })) !== null && _a !== void 0 ? _a : null;
+            if (!pluggable) {
+                logger.debug("No plugin found with name " + providerName);
+            }
+            return pluggable;
+        };
+        /**
+         * Add plugin into PushNotification
+         * @param {PushNotificationProvider} pluggable - an instance of the plugin
+         */
+        this.addPluggable = function (pluggable) {
+            if (pluggable &&
+                pluggable.getCategory() === 'Notifications' &&
+                pluggable.getSubCategory() === 'PushNotification') {
+                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
+         */
+        this.removePluggable = function (providerName) {
+            var index = _this.pluggables.findIndex(function (pluggable) { return pluggable.getProviderName() === providerName; });
+            if (index === -1) {
+                logger.debug("No plugin found with name " + providerName);
+            }
+            else {
+                _this.pluggables.splice(index, 1);
+            }
+        };
+        this.enable = function () {
+            if (_this.isEnabled) {
+                logger.info('Notification listeners have already been enabled');
+                return;
+            }
+            var _a = _this.nativeEvent, BACKGROUND_MESSAGE_RECEIVED = _a.BACKGROUND_MESSAGE_RECEIVED, FOREGROUND_MESSAGE_RECEIVED = _a.FOREGROUND_MESSAGE_RECEIVED, LAUNCH_NOTIFICATION_OPENED = _a.LAUNCH_NOTIFICATION_OPENED, NOTIFICATION_OPENED = _a.NOTIFICATION_OPENED, TOKEN_RECEIVED = _a.TOKEN_RECEIVED;
+            if (_this.nativeHeadlessTaskKey) {
+                // on platforms that can handle headless tasks, register one to broadcast background message received to
+                // library listeners
+                AppRegistry.registerHeadlessTask(_this.nativeHeadlessTaskKey, function () { return function (message) { return __awaiter(_this, void 0, void 0, function () {
+                    return __generator(this, function (_a) {
+                        switch (_a.label) {
+                            case 0: 
+                            // keep headless task running until handlers have completed their work
+                            return [4 /*yield*/, notifyEventListenersAndAwaitHandlers(0 /* BACKGROUND_MESSAGE_RECEIVED */, normalizeNativeMessage(message))];
+                            case 1:
+                                // keep headless task running until handlers have completed their work
+                                _a.sent();
+                                return [2 /*return*/];
+                        }
+                    });
+                }); }; });
+            }
+            else if (BACKGROUND_MESSAGE_RECEIVED) {
+                // on platforms that can't handle headless tasks, listen for native background message received event and
+                // broadcast to library listeners
+                _this.nativeEventEmitter.addListener(BACKGROUND_MESSAGE_RECEIVED, function (message) { return __awaiter(_this, void 0, void 0, function () {
+                    var err_1;
+                    var _a, _b;
+                    return __generator(this, function (_c) {
+                        switch (_c.label) {
+                            case 0:
+                                _c.trys.push([0, 2, 3, 4]);
+                                return [4 /*yield*/, Promise.race([
+                                        notifyEventListenersAndAwaitHandlers(0 /* BACKGROUND_MESSAGE_RECEIVED */, normalizeNativeMessage(message)),
+                                        // background tasks will get suspended and all future tasks be deprioritized by the OS if they run for
+                                        // more than 30 seconds so we reject with a error in a shorter amount of time to prevent this from
+                                        // happening
+                                        new Promise(function (_, reject) {
+                                            setTimeout(function () {
+                                                return reject("onNotificationReceivedInBackground handlers should complete their work within " + BACKGROUND_TASK_TIMEOUT + " seconds, but they did not.");
+                                            }, BACKGROUND_TASK_TIMEOUT * 1000);
+                                        }),
+                                    ])];
+                            case 1:
+                                _c.sent();
+                                return [3 /*break*/, 4];
+                            case 2:
+                                err_1 = _c.sent();
+                                logger.error(err_1);
+                                return [3 /*break*/, 4];
+                            case 3:
+                                // notify native module that handlers have completed their work (or timed out)
+                                (_b = (_a = this.nativeModule).completeNotification) === null || _b === void 0 ? void 0 : _b.call(_a, message.completionHandlerId);
+                                return [7 /*endfinally*/];
+                            case 4: return [2 /*return*/];
+                        }
+                    });
+                }); });
+            }
+            _this.nativeEventEmitter.addListener(
+            // listen for native foreground message received event and broadcast to library listeners
+            FOREGROUND_MESSAGE_RECEIVED, function (message) {
+                notifyEventListeners(1 /* FOREGROUND_MESSAGE_RECEIVED */, normalizeNativeMessage(message));
+            });
+            var launchNotificationOpenedListener = LAUNCH_NOTIFICATION_OPENED
+                ? _this.nativeEventEmitter.addListener(
+                // listen for native notification opened app (user tapped on notification, opening the app from quit -
+                // not background - state) event. This is broadcasted to an internal listener only as it is not intended
+                // for use otherwise as it produces inconsistent results when used within React Native app context
+                LAUNCH_NOTIFICATION_OPENED, function (message) {
+                    notifyEventListeners(2 /* LAUNCH_NOTIFICATION_OPENED */, normalizeNativeMessage(message));
+                    // once we are done with it we can remove the listener
+                    launchNotificationOpenedListener === null || launchNotificationOpenedListener === void 0 ? void 0 : launchNotificationOpenedListener.remove();
+                })
+                : null;
+            _this.nativeEventEmitter.addListener(
+            // listen for native notification opened (user tapped on notification, opening the app from background -
+            // not quit - state) event and broadcast to library listeners
+            NOTIFICATION_OPENED, function (message) {
+                notifyEventListeners(3 /* NOTIFICATION_OPENED */, normalizeNativeMessage(message));
+                // if we are in this state, we no longer need the listener as the app was launched via some other means
+                launchNotificationOpenedListener === null || launchNotificationOpenedListener === void 0 ? void 0 : launchNotificationOpenedListener.remove();
+            });
+            _this.nativeEventEmitter.addListener(
+            // listen for native new token event, automatically re-register device with provider using new token and
+            // broadcast to library listeners
+            TOKEN_RECEIVED, function (_a) {
+                var token = _a.token;
+                // avoid a race condition where two endpoints are created with the same token on a fresh install
+                if (_this.token === token) {
+                    return;
+                }
+                _this.token = token;
+                _this.registerDevice();
+                notifyEventListeners(4 /* TOKEN_RECEIVED */, token);
+            });
+            _this.isEnabled = true;
+        };
+        this.identifyUser = function (userId, userInfo) {
+            _this.assertIsEnabled();
+            return Promise.all(_this.pluggables.map(function (pluggable) { return __awaiter(_this, void 0, void 0, function () {
+                var err_2;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            _a.trys.push([0, 2, , 3]);
+                            return [4 /*yield*/, pluggable.identifyUser(userId, userInfo)];
+                        case 1:
+                            _a.sent();
+                            return [3 /*break*/, 3];
+                        case 2:
+                            err_2 = _a.sent();
+                            logger.error('Failed to identify user', err_2);
+                            throw err_2;
+                        case 3: return [2 /*return*/];
+                    }
+                });
+            }); }));
+        };
+        this.getLaunchNotification = function () { return __awaiter(_this, void 0, void 0, function () {
+            var _a;
+            var _b, _c;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        this.assertIsEnabled();
+                        _a = normalizeNativeMessage;
+                        return [4 /*yield*/, ((_c = (_b = this.nativeModule).getLaunchNotification) === null || _c === void 0 ? void 0 : _c.call(_b))];
+                    case 1: return [2 /*return*/, _a.apply(void 0, [_d.sent()])];
+                }
+            });
+        }); };
+        this.getBadgeCount = function () { return __awaiter(_this, void 0, void 0, function () {
+            var _a, _b;
+            return __generator(this, function (_c) {
+                this.assertIsEnabled();
+                return [2 /*return*/, (_b = (_a = this.nativeModule).getBadgeCount) === null || _b === void 0 ? void 0 : _b.call(_a)];
+            });
+        }); };
+        this.setBadgeCount = function (count) {
+            var _a, _b;
+            _this.assertIsEnabled();
+            return (_b = (_a = _this.nativeModule).setBadgeCount) === null || _b === void 0 ? void 0 : _b.call(_a, count);
+        };
+        this.getPermissionStatus = function () { return __awaiter(_this, void 0, void 0, function () {
+            var _a;
+            var _b, _c;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        this.assertIsEnabled();
+                        _a = normalizeNativePermissionStatus;
+                        return [4 /*yield*/, ((_c = (_b = this.nativeModule).getPermissionStatus) === null || _c === void 0 ? void 0 : _c.call(_b))];
+                    case 1: return [2 /*return*/, _a.apply(void 0, [_d.sent()])];
+                }
+            });
+        }); };
+        this.requestPermissions = function (permissions) {
+            if (permissions === void 0) { permissions = {
+                alert: true,
+                badge: true,
+                sound: true,
+            }; }
+            return __awaiter(_this, void 0, void 0, function () {
+                var _a, _b;
+                return __generator(this, function (_c) {
+                    this.assertIsEnabled();
+                    return [2 /*return*/, (_b = (_a = this.nativeModule).requestPermissions) === null || _b === void 0 ? void 0 : _b.call(_a, permissions)];
+                });
+            });
+        };
+        /**
+         * Background notifications on will start the app (as a headless JS instance running on a background service on
+         * Android) in the background. Handlers registered via `onNotificationReceivedInBackground` should return Promises if
+         * it needs to be asynchronous (e.g. to perform some network requests). The app should run in the background as long
+         * as there are handlers still running (however, if they run for more than 30 seconds on iOS, subsequent tasks could
+         * get deprioritized!). If it is necessary for a handler to execute while the app is in quit state, it should be
+         * registered in the application entry point (e.g. index.js) since the application will not fully mount in that case.
+         *
+         * @param handler a function to be run when a BACKGROUND_MESSAGE_RECEIVED event is received
+         * @returns an event listener which should be removed when no longer needed
+         */
+        this.onNotificationReceivedInBackground = function (handler) {
+            _this.assertIsEnabled();
+            return addEventListener(0 /* BACKGROUND_MESSAGE_RECEIVED */, handler);
+        };
+        this.onNotificationReceivedInForeground = function (handler) {
+            _this.assertIsEnabled();
+            return addEventListener(1 /* FOREGROUND_MESSAGE_RECEIVED */, handler);
+        };
+        this.onNotificationOpened = function (handler) {
+            _this.assertIsEnabled();
+            return addEventListener(3 /* NOTIFICATION_OPENED */, handler);
+        };
+        this.onTokenReceived = function (handler) {
+            _this.assertIsEnabled();
+            return addEventListener(4 /* TOKEN_RECEIVED */, handler);
+        };
+        this.registerDevice = function () { return __awaiter(_this, void 0, void 0, function () {
+            var _this = this;
+            return __generator(this, function (_a) {
+                return [2 /*return*/, Promise.all(this.pluggables.map(function (pluggable) { return __awaiter(_this, void 0, void 0, function () {
+                        var err_3;
+                        return __generator(this, function (_a) {
+                            switch (_a.label) {
+                                case 0:
+                                    _a.trys.push([0, 2, , 3]);
+                                    return [4 /*yield*/, pluggable.registerDevice(this.token)];
+                                case 1:
+                                    _a.sent();
+                                    return [3 /*break*/, 3];
+                                case 2:
+                                    err_3 = _a.sent();
+                                    logger.error('Failed to register device for push notifications', err_3);
+                                    throw err_3;
+                                case 3: return [2 /*return*/];
+                            }
+                        });
+                    }); }))];
+            });
+        }); };
+        this.assertIsEnabled = function () {
+            if (!_this.isEnabled) {
+                throw new NotEnabledError();
+            }
+        };
+        try {
+            this.nativeModule = AmplifyRTNPushNotification;
+            var _a = this.nativeModule.getConstants(), NativeEvent = _a.NativeEvent, NativeHeadlessTaskKey = _a.NativeHeadlessTaskKey;
+            this.nativeEvent = NativeEvent;
+            this.nativeHeadlessTaskKey = NativeHeadlessTaskKey;
+            this.nativeEventEmitter = new NativeEventEmitter(AmplifyRTNPushNotification);
+        }
+        catch (err) {
+            err.message = "Unable to find " + RTN_MODULE + ". " + err.message;
+            throw err;
+        }
+    }
+    /**
+     * Get the name of this module
+     * @returns {string} name of this module
+     */
+    PushNotification.prototype.getModuleName = function () {
+        return 'PushNotification';
+    };
+    return PushNotification;
+}());
+export default PushNotification;
+//# sourceMappingURL=PushNotification.native.js.map

package/lib-esm/PushNotification/PushNotification.native.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PushNotification.native.js","sourceRoot":"","sources":["../../src/PushNotification/PushNotification.native.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC;;AAEtC,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,EAAE,aAAa,IAAI,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,EACN,0BAA0B,GAE1B,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EACN,gBAAgB,EAEhB,oBAAoB,EACpB,oCAAoC,GACpC,MAAM,WAAW,CAAC;AAEnB,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAalD,OAAO,EACN,+BAA+B,EAC/B,sBAAsB,GACtB,MAAM,SAAS,CAAC;AAEjB,IAAM,MAAM,GAAG,IAAI,MAAM,CAAC,gCAAgC,CAAC,CAAC;AAC5D,IAAM,UAAU,GAAG,oCAAoC,CAAC;AACxD,IAAM,uBAAuB,GAAG,EAAE,CAAC,CAAC,UAAU;AAE9C;IAUC;QAAA,iBAcC;QAvBO,cAAS,GAAG,KAAK,CAAC;QAClB,WAAM,GAAwB,EAAE,CAAC;QAKjC,eAAU,GAA+B,EAAE,CAAC;QAmBpD;;;WAGG;QACH,cAAS,GAAG,UAAC,MAAmC;YAAnC,uBAAA,EAAA,WAAmC;YAC/C,KAAI,CAAC,MAAM,yBAAQ,KAAI,CAAC,MAAM,GAAK,MAAM,CAAE,CAAC;YAE5C,MAAM,CAAC,KAAK,CAAC,4BAA4B,EAAE,KAAI,CAAC,MAAM,CAAC,CAAC;YAExD,KAAI,CAAC,UAAU,CAAC,OAAO,CAAC,UAAA,SAAS;gBAChC,SAAS,CAAC,SAAS,CAAC,KAAI,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;YAC/D,CAAC,CAAC,CAAC;YAEH,IAAI,KAAI,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;gBACjC,KAAI,CAAC,YAAY,CAAC,IAAI,mBAAmB,EAAE,CAAC,CAAC;aAC7C;YAED,OAAO,KAAI,CAAC,MAAM,CAAC;QACpB,CAAC,CAAC;QAUF;;;WAGG;QACH,iBAAY,GAAG,UAAC,YAAoB;;YACnC,IAAM,SAAS,SACd,KAAI,CAAC,UAAU,CAAC,IAAI,CACnB,UAAA,SAAS,IAAI,OAAA,SAAS,CAAC,eAAe,EAAE,KAAK,YAAY,EAA5C,CAA4C,CACzD,mCAAI,IAAI,CAAC;YAEX,IAAI,CAAC,SAAS,EAAE;gBACf,MAAM,CAAC,KAAK,CAAC,+BAA6B,YAAc,CAAC,CAAC;aAC1D;YAED,OAAO,SAAS,CAAC;QAClB,CAAC,CAAC;QAEF;;;WAGG;QACH,iBAAY,GAAG,UAAC,SAAmC;YAClD,IACC,SAAS;gBACT,SAAS,CAAC,WAAW,EAAE,KAAK,eAAe;gBAC3C,SAAS,CAAC,cAAc,EAAE,KAAK,kBAAkB,EAChD;gBACD,IAAI,KAAI,CAAC,YAAY,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC,EAAE;oBACnD,MAAM,IAAI,KAAK,CACd,eAAa,SAAS,CAAC,eAAe,EAAE,6BAA0B,CAClE,CAAC;iBACF;gBACD,KAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAChC,SAAS,CAAC,SAAS,CAAC,KAAI,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;aAC9D;QACF,CAAC,CAAC;QAEF;;;WAGG;QACH,oBAAe,GAAG,UAAC,YAAoB;YACtC,IAAM,KAAK,GAAG,KAAI,CAAC,UAAU,CAAC,SAAS,CACtC,UAAA,SAAS,IAAI,OAAA,SAAS,CAAC,eAAe,EAAE,KAAK,YAAY,EAA5C,CAA4C,CACzD,CAAC;YACF,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;gBACjB,MAAM,CAAC,KAAK,CAAC,+BAA6B,YAAc,CAAC,CAAC;aAC1D;iBAAM;gBACN,KAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;aACjC;QACF,CAAC,CAAC;QAEF,WAAM,GAAG;YACR,IAAI,KAAI,CAAC,SAAS,EAAE;gBACnB,MAAM,CAAC,IAAI,CAAC,kDAAkD,CAAC,CAAC;gBAChE,OAAO;aACP;YACK,IAAA,sBAMc,EALnB,4DAA2B,EAC3B,4DAA2B,EAC3B,0DAA0B,EAC1B,4CAAmB,EACnB,kCACmB,CAAC;YACrB,IAAI,KAAI,CAAC,qBAAqB,EAAE;gBAC/B,wGAAwG;gBACxG,oBAAoB;gBACpB,WAAW,CAAC,oBAAoB,CAC/B,KAAI,CAAC,qBAAqB,EAC1B,cAAM,OAAA,UAAM,OAAO;;;;4BAClB,sEAAsE;4BACtE,qBAAM,oCAAoC,sCAEzC,sBAAsB,CAAC,OAAO,CAAC,CAC/B,EAAA;;gCAJD,sEAAsE;gCACtE,SAGC,CAAC;;;;qBACF,EANK,CAML,CACD,CAAC;aACF;iBAAM,IAAI,2BAA2B,EAAE;gBACvC,yGAAyG;gBACzG,iCAAiC;gBACjC,KAAI,CAAC,kBAAkB,CAAC,WAAW,CAClC,2BAA2B,EAC3B,UAAM,OAAO;;;;;;;gCAGX,qBAAM,OAAO,CAAC,IAAI,CAAC;wCAClB,oCAAoC,sCAEnC,sBAAsB,CAAC,OAAO,CAAC,CAC/B;wCACD,sGAAsG;wCACtG,kGAAkG;wCAClG,YAAY;wCACZ,IAAI,OAAO,CAAC,UAAC,CAAC,EAAE,MAAM;4CACrB,UAAU,CACT;gDACC,OAAA,MAAM,CACL,mFAAiF,uBAAuB,gCAA6B,CACrI;4CAFD,CAEC,EACF,uBAAuB,GAAG,IAAI,CAC9B,CAAC;wCACH,CAAC,CAAC;qCACF,CAAC,EAAA;;gCAjBF,SAiBE,CAAC;;;;gCAEH,MAAM,CAAC,KAAK,CAAC,KAAG,CAAC,CAAC;;;gCAElB,8EAA8E;gCAC9E,MAAA,MAAA,IAAI,CAAC,YAAY,EAAC,oBAAoB,mDACrC,OAAO,CAAC,mBAAmB,EAC1B;;;;;qBAEH,CACD,CAAC;aACF;YAED,KAAI,CAAC,kBAAkB,CAAC,WAAW;YAClC,yFAAyF;YACzF,2BAA2B,EAC3B,UAAA,OAAO;gBACN,oBAAoB,sCAEnB,sBAAsB,CAAC,OAAO,CAAC,CAC/B,CAAC;YACH,CAAC,CACD,CAAC;YAEF,IAAM,gCAAgC,GAAG,0BAA0B;gBAClE,CAAC,CAAC,KAAI,CAAC,kBAAkB,CAAC,WAAW;gBACnC,sGAAsG;gBACtG,wGAAwG;gBACxG,kGAAkG;gBAClG,0BAA0B,EAC1B,UAAA,OAAO;oBACN,oBAAoB,qCAEnB,sBAAsB,CAAC,OAAO,CAAC,CAC/B,CAAC;oBACF,sDAAsD;oBACtD,gCAAgC,aAAhC,gCAAgC,uBAAhC,gCAAgC,CAAE,MAAM,GAAG;gBAC5C,CAAC,CACA;gBACH,CAAC,CAAC,IAAI,CAAC;YAER,KAAI,CAAC,kBAAkB,CAAC,WAAW;YAClC,wGAAwG;YACxG,6DAA6D;YAC7D,mBAAmB,EACnB,UAAA,OAAO;gBACN,oBAAoB,8BAEnB,sBAAsB,CAAC,OAAO,CAAC,CAC/B,CAAC;gBACF,uGAAuG;gBACvG,gCAAgC,aAAhC,gCAAgC,uBAAhC,gCAAgC,CAAE,MAAM,GAAG;YAC5C,CAAC,CACD,CAAC;YAEF,KAAI,CAAC,kBAAkB,CAAC,WAAW;YAClC,wGAAwG;YACxG,iCAAiC;YACjC,cAAc,EACd,UAAC,EAAS;oBAAP,gBAAK;gBACP,gGAAgG;gBAChG,IAAI,KAAI,CAAC,KAAK,KAAK,KAAK,EAAE;oBACzB,OAAO;iBACP;gBACD,KAAI,CAAC,KAAK,GAAG,KAAK,CAAC;gBACnB,KAAI,CAAC,cAAc,EAAE,CAAC;gBACtB,oBAAoB,yBAAuC,KAAK,CAAC,CAAC;YACnE,CAAC,CACD,CAAC;YACF,KAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACvB,CAAC,CAAC;QAEF,iBAAY,GAAG,UAAC,MAAc,EAAE,QAAkB;YACjD,KAAI,CAAC,eAAe,EAAE,CAAC;YACvB,OAAO,OAAO,CAAC,GAAG,CACjB,KAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAM,SAAS;;;;;;4BAEjC,qBAAM,SAAS,CAAC,YAAY,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAA;;4BAA9C,SAA8C,CAAC;;;;4BAE/C,MAAM,CAAC,KAAK,CAAC,yBAAyB,EAAE,KAAG,CAAC,CAAC;4BAC7C,MAAM,KAAG,CAAC;;;;iBAEX,CAAC,CACF,CAAC;QACH,CAAC,CAAC;QAEF,0BAAqB,GAAG;;;;;;wBACvB,IAAI,CAAC,eAAe,EAAE,CAAC;wBAChB,KAAA,sBAAsB,CAAA;wBAC5B,4BAAM,MAAA,IAAI,CAAC,YAAY,EAAC,qBAAqB,qDAAI;4BADlD,sBAAO,kBACN,SAAiD,EACjD,EAAC;;;aACF,CAAC;QAEF,kBAAa,GAAG;;;gBACf,IAAI,CAAC,eAAe,EAAE,CAAC;gBACvB,4BAAO,MAAA,IAAI,CAAC,YAAY,EAAC,aAAa,oDAAK;;aAC3C,CAAC;QAEF,kBAAa,GAAG,UAAC,KAAa;;YAC7B,KAAI,CAAC,eAAe,EAAE,CAAC;YACvB,aAAO,MAAA,KAAI,CAAC,YAAY,EAAC,aAAa,mDAAG,KAAK,EAAE;QACjD,CAAC,CAAC;QAEF,wBAAmB,GAAG;;;;;;wBACrB,IAAI,CAAC,eAAe,EAAE,CAAC;wBAChB,KAAA,+BAA+B,CAAA;wBACrC,4BAAM,MAAA,IAAI,CAAC,YAAY,EAAC,mBAAmB,qDAAI;4BADhD,sBAAO,kBACN,SAA+C,EAC/C,EAAC;;;aACF,CAAC;QAEF,uBAAkB,GAAG,UACpB,WAIC;YAJD,4BAAA,EAAA;gBACC,KAAK,EAAE,IAAI;gBACX,KAAK,EAAE,IAAI;gBACX,KAAK,EAAE,IAAI;aACX;;;;oBAED,IAAI,CAAC,eAAe,EAAE,CAAC;oBACvB,4BAAO,MAAA,IAAI,CAAC,YAAY,EAAC,kBAAkB,mDAAG,WAAW,GAAE;;;SAC3D,CAAC;QAEF;;;;;;;;;;WAUG;QACH,uCAAkC,GAAG,UACpC,OAAyC;YAEzC,KAAI,CAAC,eAAe,EAAE,CAAC;YACvB,OAAO,gBAAgB,sCAEtB,OAAO,CACP,CAAC;QACH,CAAC,CAAC;QAEF,uCAAkC,GAAG,UACpC,OAAyC;YAEzC,KAAI,CAAC,eAAe,EAAE,CAAC;YACvB,OAAO,gBAAgB,sCAEtB,OAAO,CACP,CAAC;QACH,CAAC,CAAC;QAEF,yBAAoB,GAAG,UACtB,OAAyC;YAEzC,KAAI,CAAC,eAAe,EAAE,CAAC;YACvB,OAAO,gBAAgB,8BAA4C,OAAO,CAAC,CAAC;QAC7E,CAAC,CAAC;QAEF,oBAAe,GAAG,UACjB,OAA+B;YAE/B,KAAI,CAAC,eAAe,EAAE,CAAC;YACvB,OAAO,gBAAgB,yBAAuC,OAAO,CAAC,CAAC;QACxE,CAAC,CAAC;QAEM,mBAAc,GAAG;;;gBACxB,sBAAO,OAAO,CAAC,GAAG,CACjB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAM,SAAS;;;;;;oCAEjC,qBAAM,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,EAAA;;oCAA1C,SAA0C,CAAC;;;;oCAE3C,MAAM,CAAC,KAAK,CAAC,kDAAkD,EAAE,KAAG,CAAC,CAAC;oCACtE,MAAM,KAAG,CAAC;;;;yBAEX,CAAC,CACF,EAAC;;aACF,CAAC;QAEM,oBAAe,GAAG;YACzB,IAAI,CAAC,KAAI,CAAC,SAAS,EAAE;gBACpB,MAAM,IAAI,eAAe,EAAE,CAAC;aAC5B;QACF,CAAC,CAAC;QAxUD,IAAI;YACH,IAAI,CAAC,YAAY,GAAG,0BAA0B,CAAC;YACzC,IAAA,qCAC2B,EADzB,4BAAW,EAAE,gDACY,CAAC;YAClC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;YAC/B,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;YACnD,IAAI,CAAC,kBAAkB,GAAG,IAAI,kBAAkB,CAC/C,0BAA0B,CAC1B,CAAC;SACF;QAAC,OAAO,GAAG,EAAE;YACb,GAAG,CAAC,OAAO,GAAG,oBAAkB,UAAU,UAAK,GAAG,CAAC,OAAS,CAAC;YAC7D,MAAM,GAAG,CAAC;SACV;IACF,CAAC;IAsBD;;;OAGG;IACH,wCAAa,GAAb;QACC,OAAO,kBAAkB,CAAC;IAC3B,CAAC;IAgSF,uBAAC;AAAD,CAAC,AApVD,IAoVC"}

package/lib-esm/PushNotification/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from './PushNotification';
+export { PushNotificationEvent, PushNotificationMessage, PushNotificationPermissionStatus, } from './types';

package/lib-esm/PushNotification/index.js

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

package/lib-esm/PushNotification/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/PushNotification/index.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC;AAEtC,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAGN,gCAAgC,GAChC,MAAM,SAAS,CAAC"}

package/lib-esm/PushNotification/types.d.ts

@@ -0,0 +1,77 @@
+import { EventListener } from '../common';
+import { AWSPinpointProviderConfig } from '../common/AWSPinpointProviderCommon/types';
+import { NotificationsProvider, NotificationsSubCategory as NotificationsSubCategories, UserInfo } from '../types';
+export declare 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 {
+    getSubCategory(): NotificationsSubCategory;
+    registerDevice(token: string): Promise<void>;
+}
+export interface PushNotificationConfig {
+    AWSPinpoint?: AWSPinpointProviderConfig;
+}
+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 Record<string, boolean> {
+    alert?: boolean;
+    badge?: boolean;
+    sound?: boolean;
+}
+export declare enum PushNotificationPermissionStatus {
+    DENIED = "DENIED",
+    GRANTED = "GRANTED",
+    SHOULD_REQUEST = "SHOULD_REQUEST",
+    SHOULD_EXPLAIN_THEN_REQUEST = "SHOULD_EXPLAIN_THEN_REQUEST"
+}
+export declare type OnTokenReceivedHandler = (token: string) => any;
+export declare type OnPushNotificationMessageHandler = (message: PushNotificationMessage) => any;
+export declare const enum PushNotificationEvent {
+    BACKGROUND_MESSAGE_RECEIVED = 0,
+    FOREGROUND_MESSAGE_RECEIVED = 1,
+    LAUNCH_NOTIFICATION_OPENED = 2,
+    NOTIFICATION_OPENED = 3,
+    TOKEN_RECEIVED = 4
+}
+export interface NormalizedValues {
+    body?: string;
+    imageUrl?: string;
+    title?: string;
+    action?: Pick<PushNotificationMessage, 'goToUrl' | 'deeplinkUrl'>;
+    options?: Pick<PushNotificationMessage, 'apnsOptions' | 'fcmOptions'>;
+    data?: Record<string, unknown>;
+}
+export {};

package/lib-esm/PushNotification/types.js

@@ -0,0 +1,10 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export var PushNotificationPermissionStatus;
+(function (PushNotificationPermissionStatus) {
+    PushNotificationPermissionStatus["DENIED"] = "DENIED";
+    PushNotificationPermissionStatus["GRANTED"] = "GRANTED";
+    PushNotificationPermissionStatus["SHOULD_REQUEST"] = "SHOULD_REQUEST";
+    PushNotificationPermissionStatus["SHOULD_EXPLAIN_THEN_REQUEST"] = "SHOULD_EXPLAIN_THEN_REQUEST";
+})(PushNotificationPermissionStatus || (PushNotificationPermissionStatus = {}));
+//# sourceMappingURL=types.js.map

package/lib-esm/PushNotification/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/PushNotification/types.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC;AAoFtC,MAAM,CAAN,IAAY,gCAKX;AALD,WAAY,gCAAgC;IAC3C,qDAAiB,CAAA;IACjB,uDAAmB,CAAA;IACnB,qEAAiC,CAAA;IACjC,+FAA2D,CAAA;AAC5D,CAAC,EALW,gCAAgC,KAAhC,gCAAgC,QAK3C"}

package/lib-esm/PushNotification/utils.d.ts

@@ -0,0 +1,3 @@
+import { PushNotificationMessage, PushNotificationPermissionStatus } from './types';
+export declare const normalizeNativePermissionStatus: (nativeStatus?: any) => PushNotificationPermissionStatus;
+export declare const normalizeNativeMessage: (nativeMessage?: any) => PushNotificationMessage;