@aws-amplify/notifications 1.6.6-api-v6-models.b3abc9b.0 → 2.0.0

package/lib/pushNotifications/providers/pinpoint/apis/initializePushNotifications.js

@@ -0,0 +1,25 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initializePushNotifications = void 0;
+const utils_1 = require("@aws-amplify/core/internals/utils");
+/**
+ * Initialize and set up the push notification category. The category must be first initialized before all other
+ * functionalities become available.
+ *
+ * @throws platform: {@link PlatformNotSupportedError} - Thrown if called against an unsupported platform. Currently,
+ * only React Native is supported by this API.
+ * @remarks
+ * It is recommended that this be called as early in your app as possible at the root of your application to allow
+ * background processing of notifications.
+ * @example
+ * ```ts
+ * Amplify.configure(config);
+ * initializePushNotifications();
+ * ```
+ */
+const initializePushNotifications = () => {
+    throw new utils_1.PlatformNotSupportedError();
+};
+exports.initializePushNotifications = initializePushNotifications;

package/lib/pushNotifications/providers/pinpoint/apis/initializePushNotifications.native.d.ts

@@ -0,0 +1 @@
+export declare const initializePushNotifications: () => void;

package/lib/pushNotifications/providers/pinpoint/apis/initializePushNotifications.native.js

@@ -0,0 +1,133 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initializePushNotifications = void 0;
+const core_1 = require("@aws-amplify/core");
+const utils_1 = require("@aws-amplify/core/internals/utils");
+const pinpoint_1 = require("@aws-amplify/core/internals/providers/pinpoint");
+const react_native_1 = require("@aws-amplify/react-native");
+const eventListeners_1 = require("../../../../eventListeners");
+const utils_2 = require("../../../utils");
+const utils_3 = require("../utils");
+const { addMessageEventListener, addTokenEventListener, completeNotification, getConstants, registerHeadlessTask, } = (0, react_native_1.loadAmplifyPushNotification)();
+const logger = new core_1.ConsoleLogger('Notifications.PushNotification');
+const BACKGROUND_TASK_TIMEOUT = 25; // seconds
+const initializePushNotifications = () => {
+    if ((0, utils_2.isInitialized)()) {
+        logger.info('Push notifications have already been enabled');
+        return;
+    }
+    addNativeListeners();
+    addAnalyticsListeners();
+    (0, utils_2.initialize)();
+};
+exports.initializePushNotifications = initializePushNotifications;
+const addNativeListeners = () => {
+    let launchNotificationOpenedListener;
+    const { NativeEvent, NativeHeadlessTaskKey } = getConstants();
+    const { BACKGROUND_MESSAGE_RECEIVED, FOREGROUND_MESSAGE_RECEIVED, LAUNCH_NOTIFICATION_OPENED, NOTIFICATION_OPENED, TOKEN_RECEIVED, } = NativeEvent;
+    // on platforms that can handle headless tasks, register one to broadcast background message received to
+    // library listeners
+    if (NativeHeadlessTaskKey) {
+        registerHeadlessTask(async (message) => {
+            // keep headless task running until handlers have completed their work
+            await (0, eventListeners_1.notifyEventListenersAndAwaitHandlers)('backgroundMessageReceived', message);
+        });
+    }
+    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
+        addMessageEventListener(BACKGROUND_MESSAGE_RECEIVED, async (message, completionHandlerId) => {
+            // keep background task running until handlers have completed their work
+            try {
+                await Promise.race([
+                    (0, eventListeners_1.notifyEventListenersAndAwaitHandlers)('backgroundMessageReceived', 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((_, reject) => {
+                        setTimeout(() => reject(`onNotificationReceivedInBackground handlers should complete their work within ${BACKGROUND_TASK_TIMEOUT} seconds, but they did not.`), BACKGROUND_TASK_TIMEOUT * 1000);
+                    }),
+                ]);
+            }
+            catch (err) {
+                logger.error(err);
+            }
+            finally {
+                // notify native module that handlers have completed their work (or timed out)
+                if (completionHandlerId) {
+                    completeNotification(completionHandlerId);
+                }
+            }
+        });
+    }
+    addMessageEventListener(
+    // listen for native foreground message received event and broadcast to library listeners
+    FOREGROUND_MESSAGE_RECEIVED, message => {
+        (0, eventListeners_1.notifyEventListeners)('foregroundMessageReceived', message);
+    });
+    launchNotificationOpenedListener = LAUNCH_NOTIFICATION_OPENED
+        ? addMessageEventListener(
+        // 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, message => {
+            (0, eventListeners_1.notifyEventListeners)('launchNotificationOpened', message);
+            // once we are done with it we can remove the listener
+            launchNotificationOpenedListener?.remove();
+        })
+        : null;
+    addMessageEventListener(
+    // 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, message => {
+        (0, eventListeners_1.notifyEventListeners)('notificationOpened', message);
+        // if we are in this state, we no longer need the listener as the app was launched via some other means
+        launchNotificationOpenedListener?.remove();
+    });
+    addTokenEventListener(
+    // listen for native new token event, automatically re-register device with provider using new token and
+    // broadcast to library listeners
+    TOKEN_RECEIVED, async (token) => {
+        // avoid a race condition where two endpoints are created with the same token on a fresh install
+        if ((0, utils_2.getToken)() === token) {
+            return;
+        }
+        (0, utils_2.setToken)(token);
+        (0, eventListeners_1.notifyEventListeners)('tokenReceived', token);
+        try {
+            await registerDevice(token);
+        }
+        catch (err) {
+            logger.error('Failed to register device for push notifications', err);
+            throw err;
+        }
+    });
+};
+const addAnalyticsListeners = () => {
+    let launchNotificationOpenedListenerRemover;
+    // wire up default Pinpoint message event handling
+    (0, eventListeners_1.addEventListener)('backgroundMessageReceived', (0, utils_3.createMessageEventRecorder)('received_background'));
+    (0, eventListeners_1.addEventListener)('foregroundMessageReceived', (0, utils_3.createMessageEventRecorder)('received_foreground'));
+    launchNotificationOpenedListenerRemover = (0, eventListeners_1.addEventListener)('launchNotificationOpened', (0, utils_3.createMessageEventRecorder)('opened_notification', 
+    // once we are done with it we can remove the listener
+    launchNotificationOpenedListenerRemover?.remove));
+    (0, eventListeners_1.addEventListener)('notificationOpened', (0, utils_3.createMessageEventRecorder)('opened_notification', 
+    // if we are in this state, we no longer need the listener as the app was launched via some other means
+    launchNotificationOpenedListenerRemover?.remove));
+};
+const registerDevice = async (address) => {
+    const { credentials, identityId } = await (0, utils_2.resolveCredentials)();
+    const { appId, region } = (0, utils_3.resolveConfig)();
+    await (0, pinpoint_1.updateEndpoint)({
+        address,
+        appId,
+        category: 'PushNotification',
+        credentials,
+        region,
+        channelType: (0, utils_3.getChannelType)(),
+        identityId,
+        userAgentValue: (0, utils_2.getPushNotificationUserAgentString)(utils_1.PushNotificationAction.InitializePushNotifications),
+    });
+};

package/lib/pushNotifications/providers/pinpoint/apis/onNotificationOpened.d.ts

@@ -0,0 +1,27 @@
+import { OnNotificationOpened } from '../types';
+/**
+ * Registers a listener that will be triggered when a notification is opened by user.
+ *
+ * @param {OnNotificationOpenedInput} input - A callback handler to be invoked with the opened
+ * {@link PushNotificationMessage}.
+ * @returns {OnNotificationOpenedOutput} - An object with a remove function to remove the listener.
+ * @example
+ * ```ts
+ * // Register a listener
+ * onNotificationOpened(message => {
+ *   doSomething(message);
+ * });
+ * ```
+ * @example
+ * ```ts
+ * // Register multiple listeners
+ * onNotificationOpened(message => {
+ *   doSomething(message);
+ * });
+ *
+ * onNotificationOpened(message => {
+ *   doSomethingElse(message);
+ * });
+ * ```
+ */
+export declare const onNotificationOpened: OnNotificationOpened;

package/lib/pushNotifications/providers/pinpoint/apis/onNotificationOpened.js

@@ -0,0 +1,35 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onNotificationOpened = void 0;
+const utils_1 = require("@aws-amplify/core/internals/utils");
+/**
+ * Registers a listener that will be triggered when a notification is opened by user.
+ *
+ * @param {OnNotificationOpenedInput} input - A callback handler to be invoked with the opened
+ * {@link PushNotificationMessage}.
+ * @returns {OnNotificationOpenedOutput} - An object with a remove function to remove the listener.
+ * @example
+ * ```ts
+ * // Register a listener
+ * onNotificationOpened(message => {
+ *   doSomething(message);
+ * });
+ * ```
+ * @example
+ * ```ts
+ * // Register multiple listeners
+ * onNotificationOpened(message => {
+ *   doSomething(message);
+ * });
+ *
+ * onNotificationOpened(message => {
+ *   doSomethingElse(message);
+ * });
+ * ```
+ */
+const onNotificationOpened = () => {
+    throw new utils_1.PlatformNotSupportedError();
+};
+exports.onNotificationOpened = onNotificationOpened;

package/lib/pushNotifications/providers/pinpoint/apis/onNotificationOpened.native.d.ts

@@ -0,0 +1,2 @@
+import { OnNotificationOpened } from '../types';
+export declare const onNotificationOpened: OnNotificationOpened;

package/lib/pushNotifications/providers/pinpoint/apis/onNotificationOpened.native.js

@@ -0,0 +1,12 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onNotificationOpened = void 0;
+const eventListeners_1 = require("../../../../eventListeners");
+const errorHelpers_1 = require("../../../errors/errorHelpers");
+const onNotificationOpened = input => {
+    (0, errorHelpers_1.assertIsInitialized)();
+    return (0, eventListeners_1.addEventListener)('notificationOpened', input);
+};
+exports.onNotificationOpened = onNotificationOpened;

package/lib/pushNotifications/providers/pinpoint/apis/onNotificationReceivedInBackground.d.ts

@@ -0,0 +1,43 @@
+import { OnNotificationReceivedInBackground } from '../types';
+/**
+ * Registers a listener that will be triggered when a notification is received while app is in a background state.
+ *
+ * @throws platform: {@link PlatformNotSupportedError} - Thrown if called against an unsupported platform. Currently,
+ * only React Native is supported by this API.
+ * @param {OnNotificationReceivedInBackgroundInput} input - A callback handler to be invoked with the received
+ * {@link PushNotificationMessage}.
+ * @returns {OnNotificationReceivedInBackgroundOutput} - An object with a remove function to remove the listener.
+ * @remarks Notifications received while app is in a quit state will start the app (as a headless JS instance running
+ * on a background service on Android) in the background. Handlers registered via this function 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.
+ * @example
+ * ```ts
+ * // Register a listener
+ * onNotificationReceivedInBackground(message => {
+ *   doSomething(message);
+ * });
+ * ```
+ * @example
+ * ```ts
+ * // Register multiple listeners
+ * onNotificationReceivedInBackground(message => {
+ *   doSomething(message);
+ * });
+ *
+ * onNotificationReceivedInBackground(message => {
+ *   doSomethingElse(message);
+ * });
+ * ```
+ * @example
+ * ```ts
+ * // Register async listener
+ * onNotificationReceivedInBackground(async message => {
+ *   await doSomething(message);
+ *   console.log(`did something with ${message}`);
+ * });
+ * ```
+ */
+export declare const onNotificationReceivedInBackground: OnNotificationReceivedInBackground;

package/lib/pushNotifications/providers/pinpoint/apis/onNotificationReceivedInBackground.js

@@ -0,0 +1,51 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onNotificationReceivedInBackground = void 0;
+const utils_1 = require("@aws-amplify/core/internals/utils");
+/**
+ * Registers a listener that will be triggered when a notification is received while app is in a background state.
+ *
+ * @throws platform: {@link PlatformNotSupportedError} - Thrown if called against an unsupported platform. Currently,
+ * only React Native is supported by this API.
+ * @param {OnNotificationReceivedInBackgroundInput} input - A callback handler to be invoked with the received
+ * {@link PushNotificationMessage}.
+ * @returns {OnNotificationReceivedInBackgroundOutput} - An object with a remove function to remove the listener.
+ * @remarks Notifications received while app is in a quit state will start the app (as a headless JS instance running
+ * on a background service on Android) in the background. Handlers registered via this function 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.
+ * @example
+ * ```ts
+ * // Register a listener
+ * onNotificationReceivedInBackground(message => {
+ *   doSomething(message);
+ * });
+ * ```
+ * @example
+ * ```ts
+ * // Register multiple listeners
+ * onNotificationReceivedInBackground(message => {
+ *   doSomething(message);
+ * });
+ *
+ * onNotificationReceivedInBackground(message => {
+ *   doSomethingElse(message);
+ * });
+ * ```
+ * @example
+ * ```ts
+ * // Register async listener
+ * onNotificationReceivedInBackground(async message => {
+ *   await doSomething(message);
+ *   console.log(`did something with ${message}`);
+ * });
+ * ```
+ */
+const onNotificationReceivedInBackground = () => {
+    throw new utils_1.PlatformNotSupportedError();
+};
+exports.onNotificationReceivedInBackground = onNotificationReceivedInBackground;

package/lib/pushNotifications/providers/pinpoint/apis/onNotificationReceivedInBackground.native.d.ts

@@ -0,0 +1,2 @@
+import { OnNotificationReceivedInBackground } from '../types';
+export declare const onNotificationReceivedInBackground: OnNotificationReceivedInBackground;

package/lib/pushNotifications/providers/pinpoint/apis/onNotificationReceivedInBackground.native.js

@@ -0,0 +1,12 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onNotificationReceivedInBackground = void 0;
+const eventListeners_1 = require("../../../../eventListeners");
+const errorHelpers_1 = require("../../../errors/errorHelpers");
+const onNotificationReceivedInBackground = input => {
+    (0, errorHelpers_1.assertIsInitialized)();
+    return (0, eventListeners_1.addEventListener)('backgroundMessageReceived', input);
+};
+exports.onNotificationReceivedInBackground = onNotificationReceivedInBackground;

package/lib/pushNotifications/providers/pinpoint/apis/onNotificationReceivedInForeground.d.ts

@@ -0,0 +1,27 @@
+import { OnNotificationReceivedInForeground } from '../types';
+/**
+ * Registers a listener that will be triggered when a notification is received while app is in a foreground state.
+ *
+ * @param {OnNotificationReceivedInForegroundInput} input - A callback handler to be invoked with the received
+ * {@link PushNotificationMessage}.
+ * @returns {OnNotificationReceivedInForegroundOutput} - An object with a remove function to remove the listener.
+ * @example
+ * ```ts
+ * // Register a listener
+ * onNotificationReceivedInForeground(message => {
+ *   doSomething(message);
+ * });
+ * ```
+ * @example
+ * ```ts
+ * // Register multiple listeners
+ * onNotificationReceivedInForeground(message => {
+ *   doSomething(message);
+ * });
+ *
+ * onNotificationReceivedInForeground(message => {
+ *   doSomethingElse(message);
+ * });
+ * ```
+ */
+export declare const onNotificationReceivedInForeground: OnNotificationReceivedInForeground;

package/lib/pushNotifications/providers/pinpoint/apis/onNotificationReceivedInForeground.js

@@ -0,0 +1,35 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onNotificationReceivedInForeground = void 0;
+const utils_1 = require("@aws-amplify/core/internals/utils");
+/**
+ * Registers a listener that will be triggered when a notification is received while app is in a foreground state.
+ *
+ * @param {OnNotificationReceivedInForegroundInput} input - A callback handler to be invoked with the received
+ * {@link PushNotificationMessage}.
+ * @returns {OnNotificationReceivedInForegroundOutput} - An object with a remove function to remove the listener.
+ * @example
+ * ```ts
+ * // Register a listener
+ * onNotificationReceivedInForeground(message => {
+ *   doSomething(message);
+ * });
+ * ```
+ * @example
+ * ```ts
+ * // Register multiple listeners
+ * onNotificationReceivedInForeground(message => {
+ *   doSomething(message);
+ * });
+ *
+ * onNotificationReceivedInForeground(message => {
+ *   doSomethingElse(message);
+ * });
+ * ```
+ */
+const onNotificationReceivedInForeground = () => {
+    throw new utils_1.PlatformNotSupportedError();
+};
+exports.onNotificationReceivedInForeground = onNotificationReceivedInForeground;

package/lib/pushNotifications/providers/pinpoint/apis/onNotificationReceivedInForeground.native.d.ts

@@ -0,0 +1,2 @@
+import { OnNotificationReceivedInForeground } from '../types';
+export declare const onNotificationReceivedInForeground: OnNotificationReceivedInForeground;

package/lib/pushNotifications/providers/pinpoint/apis/onNotificationReceivedInForeground.native.js

@@ -0,0 +1,12 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onNotificationReceivedInForeground = void 0;
+const eventListeners_1 = require("../../../../eventListeners");
+const errorHelpers_1 = require("../../../errors/errorHelpers");
+const onNotificationReceivedInForeground = input => {
+    (0, errorHelpers_1.assertIsInitialized)();
+    return (0, eventListeners_1.addEventListener)('foregroundMessageReceived', input);
+};
+exports.onNotificationReceivedInForeground = onNotificationReceivedInForeground;

package/lib/pushNotifications/providers/pinpoint/apis/onTokenReceived.d.ts

@@ -0,0 +1,28 @@
+import { OnTokenReceived } from '../types';
+/**
+ * Registers a listener that will be triggered when a token is received. A token will be received:
+ *   1. On every app launch, including the first install
+ *   2. When a token changes (this may happen if the service invalidates the token for any reason)
+ *
+ * @param {OnTokenReceivedInput} input - A callback handler to be invoked with the token.
+ * @returns {OnTokenReceivedOutput} - An object with a remove function to remove the listener.
+ * @example
+ * ```ts
+ * // Register a listener
+ * onTokenReceived(message => {
+ *   doSomething(message);
+ * });
+ * ```
+ * @example
+ * ```ts
+ * // Register multiple listeners
+ * onTokenReceived(message => {
+ *   doSomething(message);
+ * });
+ *
+ * onTokenReceived(message => {
+ *   doSomethingElse(message);
+ * });
+ * ```
+ */
+export declare const onTokenReceived: OnTokenReceived;

package/lib/pushNotifications/providers/pinpoint/apis/onTokenReceived.js

@@ -0,0 +1,36 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onTokenReceived = void 0;
+const utils_1 = require("@aws-amplify/core/internals/utils");
+/**
+ * Registers a listener that will be triggered when a token is received. A token will be received:
+ *   1. On every app launch, including the first install
+ *   2. When a token changes (this may happen if the service invalidates the token for any reason)
+ *
+ * @param {OnTokenReceivedInput} input - A callback handler to be invoked with the token.
+ * @returns {OnTokenReceivedOutput} - An object with a remove function to remove the listener.
+ * @example
+ * ```ts
+ * // Register a listener
+ * onTokenReceived(message => {
+ *   doSomething(message);
+ * });
+ * ```
+ * @example
+ * ```ts
+ * // Register multiple listeners
+ * onTokenReceived(message => {
+ *   doSomething(message);
+ * });
+ *
+ * onTokenReceived(message => {
+ *   doSomethingElse(message);
+ * });
+ * ```
+ */
+const onTokenReceived = () => {
+    throw new utils_1.PlatformNotSupportedError();
+};
+exports.onTokenReceived = onTokenReceived;

package/lib/pushNotifications/providers/pinpoint/apis/onTokenReceived.native.d.ts

@@ -0,0 +1,2 @@
+import { OnTokenReceived } from '../types';
+export declare const onTokenReceived: OnTokenReceived;

package/lib/pushNotifications/providers/pinpoint/apis/onTokenReceived.native.js

@@ -0,0 +1,12 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onTokenReceived = void 0;
+const eventListeners_1 = require("../../../../eventListeners");
+const errorHelpers_1 = require("../../../errors/errorHelpers");
+const onTokenReceived = input => {
+    (0, errorHelpers_1.assertIsInitialized)();
+    return (0, eventListeners_1.addEventListener)('tokenReceived', input);
+};
+exports.onTokenReceived = onTokenReceived;

package/lib/pushNotifications/providers/pinpoint/apis/requestPermissions.d.ts

@@ -0,0 +1,32 @@
+import { RequestPermissions } from '../types';
+/**
+ * Requests notification permissions from your user. By default, Amplify requests all supported permissions but you can
+ * choose not to request specific permissions. The resulting promise will resolve to true if requested permissions are
+ * granted (or have previously been granted) or false otherwise. Not all specific permissions are supported by platforms
+ * your React Native app can run on but will be safely ignored even on those platforms. Currently supported permissions:
+ *
+ *   * `alert`: When set to true, requests the ability to display notifications to the user.
+ *
+ *   * `sound`: When set to true, requests the ability to play a sound in response to notifications.
+ *
+ *   * `badge`: When set to true, requests the ability to update the app's badge.
+ *
+ * @throws platform: {@link PlatformNotSupportedError} - Thrown if called against an unsupported platform. Currently,
+ * only React Native is supported by this API.
+ * @returns A promise that resolves to true if requested permissions are granted or have already previously been
+ * granted or false otherwise.
+ * @example
+ * ```ts
+ * // Request all permissions by default
+ * const arePermissionsGranted = await requestPermissions();
+ *
+ * @example
+ * ```ts
+ * // Prevent requesting specific permissions
+ * const arePermissionsGranted = await requestPermissions({
+ *   sound: false,
+ *   badge: false
+ * });
+ * ```
+ */
+export declare const requestPermissions: RequestPermissions;

package/lib/pushNotifications/providers/pinpoint/apis/requestPermissions.js

@@ -0,0 +1,40 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requestPermissions = void 0;
+const utils_1 = require("@aws-amplify/core/internals/utils");
+/**
+ * Requests notification permissions from your user. By default, Amplify requests all supported permissions but you can
+ * choose not to request specific permissions. The resulting promise will resolve to true if requested permissions are
+ * granted (or have previously been granted) or false otherwise. Not all specific permissions are supported by platforms
+ * your React Native app can run on but will be safely ignored even on those platforms. Currently supported permissions:
+ *
+ *   * `alert`: When set to true, requests the ability to display notifications to the user.
+ *
+ *   * `sound`: When set to true, requests the ability to play a sound in response to notifications.
+ *
+ *   * `badge`: When set to true, requests the ability to update the app's badge.
+ *
+ * @throws platform: {@link PlatformNotSupportedError} - Thrown if called against an unsupported platform. Currently,
+ * only React Native is supported by this API.
+ * @returns A promise that resolves to true if requested permissions are granted or have already previously been
+ * granted or false otherwise.
+ * @example
+ * ```ts
+ * // Request all permissions by default
+ * const arePermissionsGranted = await requestPermissions();
+ *
+ * @example
+ * ```ts
+ * // Prevent requesting specific permissions
+ * const arePermissionsGranted = await requestPermissions({
+ *   sound: false,
+ *   badge: false
+ * });
+ * ```
+ */
+const requestPermissions = async () => {
+    throw new utils_1.PlatformNotSupportedError();
+};
+exports.requestPermissions = requestPermissions;

package/lib/pushNotifications/providers/pinpoint/apis/requestPermissions.native.d.ts

@@ -0,0 +1,2 @@
+import { RequestPermissions } from '../types';
+export declare const requestPermissions: RequestPermissions;

package/lib/pushNotifications/providers/pinpoint/apis/requestPermissions.native.js

@@ -0,0 +1,13 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requestPermissions = void 0;
+const react_native_1 = require("@aws-amplify/react-native");
+const errorHelpers_1 = require("../../../errors/errorHelpers");
+const { requestPermissions: requestPermissionsNative } = (0, react_native_1.loadAmplifyPushNotification)();
+const requestPermissions = async (input) => {
+    (0, errorHelpers_1.assertIsInitialized)();
+    return requestPermissionsNative(input);
+};
+exports.requestPermissions = requestPermissions;

package/lib/pushNotifications/providers/pinpoint/apis/setBadgeCount.d.ts

@@ -0,0 +1,14 @@
+import { SetBadgeCount } from '../types';
+/**
+ * Sets the current badge count (the number on the top right corner of your app's icon). Setting the badge count
+ * to 0 (zero) will remove the badge from your app's icon. This function is safe to call (but will be ignored) even
+ * when your React Native app is running on platforms where badges are not supported.
+ *
+ * @throws platform: {@link PlatformNotSupportedError} - Thrown if called against an unsupported platform. Currently,
+ * only React Native is supported by this API.
+ * @example
+ * ```ts
+ * setBadgeCount(42);
+ * ```
+ */
+export declare const setBadgeCount: SetBadgeCount;

package/lib/pushNotifications/providers/pinpoint/apis/setBadgeCount.js

@@ -0,0 +1,22 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setBadgeCount = void 0;
+const utils_1 = require("@aws-amplify/core/internals/utils");
+/**
+ * Sets the current badge count (the number on the top right corner of your app's icon). Setting the badge count
+ * to 0 (zero) will remove the badge from your app's icon. This function is safe to call (but will be ignored) even
+ * when your React Native app is running on platforms where badges are not supported.
+ *
+ * @throws platform: {@link PlatformNotSupportedError} - Thrown if called against an unsupported platform. Currently,
+ * only React Native is supported by this API.
+ * @example
+ * ```ts
+ * setBadgeCount(42);
+ * ```
+ */
+const setBadgeCount = () => {
+    throw new utils_1.PlatformNotSupportedError();
+};
+exports.setBadgeCount = setBadgeCount;