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

package/lib/inAppMessaging/utils/index.d.ts

@@ -0,0 +1 @@
+export { isInitialized, assertIsInitialized, initialize, } from './statusHelpers';

package/lib/inAppMessaging/utils/index.js

@@ -0,0 +1,9 @@
+"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.initialize = exports.assertIsInitialized = exports.isInitialized = void 0;
+var statusHelpers_1 = require("./statusHelpers");
+Object.defineProperty(exports, "isInitialized", { enumerable: true, get: function () { return statusHelpers_1.isInitialized; } });
+Object.defineProperty(exports, "assertIsInitialized", { enumerable: true, get: function () { return statusHelpers_1.assertIsInitialized; } });
+Object.defineProperty(exports, "initialize", { enumerable: true, get: function () { return statusHelpers_1.initialize; } });

package/lib/inAppMessaging/utils/statusHelpers.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Sets initialization status to true.
+ *
+ * @internal
+ */
+export declare const initialize: () => void;
+/**
+ * Returns the initialization status of In-App Messaging.
+ *
+ * @internal
+ */
+export declare const isInitialized: () => boolean;
+export declare function assertIsInitialized(): void;

package/lib/inAppMessaging/utils/statusHelpers.js

@@ -0,0 +1,27 @@
+"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.assertIsInitialized = exports.isInitialized = exports.initialize = void 0;
+const errors_1 = require("../errors");
+let initialized = false;
+/**
+ * Sets initialization status to true.
+ *
+ * @internal
+ */
+const initialize = () => {
+    initialized = true;
+};
+exports.initialize = initialize;
+/**
+ * Returns the initialization status of In-App Messaging.
+ *
+ * @internal
+ */
+const isInitialized = () => initialized;
+exports.isInitialized = isInitialized;
+function assertIsInitialized() {
+    (0, errors_1.assertValidationError)((0, exports.isInitialized)(), errors_1.InAppMessagingValidationErrorCode.NotInitialized);
+}
+exports.assertIsInitialized = assertIsInitialized;

package/lib/index.d.ts

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

package/lib/index.js

@@ -1,13 +1,3 @@
 "use strict";
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-Object.defineProperty(exports, "__esModule", { value: true });
-var Notifications_1 = require("./Notifications");
-exports.Notifications = Notifications_1.default;
-var common_1 = require("./common");
-exports.AWSPinpointProviderCommon = common_1.AWSPinpointProviderCommon;
-var InAppMessaging_1 = require("./InAppMessaging");
-exports.InAppMessageInteractionEvent = InAppMessaging_1.InAppMessageInteractionEvent;
-var types_1 = require("./PushNotification/types");
-exports.PushNotificationPermissionStatus = types_1.PushNotificationPermissionStatus;
-//# sourceMappingURL=index.js.map

package/lib/pushNotifications/errors/PushNotificationError.d.ts

@@ -0,0 +1,4 @@
+import { AmplifyError, AmplifyErrorParams } from '@aws-amplify/core/internals/utils';
+export declare class PushNotificationError extends AmplifyError {
+    constructor(params: AmplifyErrorParams);
+}

package/lib/pushNotifications/errors/PushNotificationError.js

@@ -0,0 +1,16 @@
+"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.PushNotificationError = void 0;
+const utils_1 = require("@aws-amplify/core/internals/utils");
+class PushNotificationError extends utils_1.AmplifyError {
+    constructor(params) {
+        super(params);
+        // Hack for making the custom error class work when transpiled to es5
+        // TODO: Delete the following 2 lines after we change the build target to >= es2015
+        this.constructor = PushNotificationError;
+        Object.setPrototypeOf(this, PushNotificationError.prototype);
+    }
+}
+exports.PushNotificationError = PushNotificationError;

package/lib/pushNotifications/errors/errorHelpers.d.ts

@@ -0,0 +1,9 @@
+import { AssertionFunction } from '@aws-amplify/core/internals/utils';
+export declare enum PushNotificationValidationErrorCode {
+    NoAppId = "NoAppId",
+    NoCredentials = "NoCredentials",
+    NoRegion = "NoRegion",
+    NotInitialized = "NotInitialized"
+}
+export declare const assert: AssertionFunction<PushNotificationValidationErrorCode>;
+export declare const assertIsInitialized: () => void;

package/lib/pushNotifications/errors/errorHelpers.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.assertIsInitialized = exports.assert = exports.PushNotificationValidationErrorCode = void 0;
+const utils_1 = require("@aws-amplify/core/internals/utils");
+const utils_2 = require("../utils");
+const PushNotificationError_1 = require("./PushNotificationError");
+var PushNotificationValidationErrorCode;
+(function (PushNotificationValidationErrorCode) {
+    PushNotificationValidationErrorCode["NoAppId"] = "NoAppId";
+    PushNotificationValidationErrorCode["NoCredentials"] = "NoCredentials";
+    PushNotificationValidationErrorCode["NoRegion"] = "NoRegion";
+    PushNotificationValidationErrorCode["NotInitialized"] = "NotInitialized";
+})(PushNotificationValidationErrorCode = exports.PushNotificationValidationErrorCode || (exports.PushNotificationValidationErrorCode = {}));
+const pushNotificationValidationErrorMap = {
+    [PushNotificationValidationErrorCode.NoAppId]: {
+        message: 'Missing application id.',
+    },
+    [PushNotificationValidationErrorCode.NoCredentials]: {
+        message: 'Credentials should not be empty.',
+    },
+    [PushNotificationValidationErrorCode.NoRegion]: {
+        message: 'Missing region.',
+    },
+    [PushNotificationValidationErrorCode.NotInitialized]: {
+        message: 'Push notification has not been initialized.',
+        recoverySuggestion: 'Please make sure to first call `initializePushNotifications`.',
+    },
+};
+exports.assert = (0, utils_1.createAssertionFunction)(pushNotificationValidationErrorMap, PushNotificationError_1.PushNotificationError);
+const assertIsInitialized = () => {
+    (0, exports.assert)((0, utils_2.isInitialized)(), PushNotificationValidationErrorCode.NotInitialized);
+};
+exports.assertIsInitialized = assertIsInitialized;

package/lib/pushNotifications/errors/index.d.ts

@@ -0,0 +1,2 @@
+export { PushNotificationError } from './PushNotificationError';
+export { assert, PushNotificationValidationErrorCode } from './errorHelpers';

package/lib/pushNotifications/errors/index.js

@@ -0,0 +1,10 @@
+"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.PushNotificationValidationErrorCode = exports.assert = exports.PushNotificationError = void 0;
+var PushNotificationError_1 = require("./PushNotificationError");
+Object.defineProperty(exports, "PushNotificationError", { enumerable: true, get: function () { return PushNotificationError_1.PushNotificationError; } });
+var errorHelpers_1 = require("./errorHelpers");
+Object.defineProperty(exports, "assert", { enumerable: true, get: function () { return errorHelpers_1.assert; } });
+Object.defineProperty(exports, "PushNotificationValidationErrorCode", { enumerable: true, get: function () { return errorHelpers_1.PushNotificationValidationErrorCode; } });

package/lib/pushNotifications/index.d.ts

@@ -0,0 +1,3 @@
+export { getBadgeCount, GetBadgeCountOutput, getLaunchNotification, GetLaunchNotificationOutput, getPermissionStatus, GetPermissionStatusOutput, identifyUser, IdentifyUserInput, initializePushNotifications, onNotificationOpened, OnNotificationOpenedInput, OnNotificationOpenedOutput, onNotificationReceivedInBackground, OnNotificationReceivedInBackgroundInput, OnNotificationReceivedInBackgroundOutput, onNotificationReceivedInForeground, OnNotificationReceivedInForegroundInput, OnNotificationReceivedInForegroundOutput, onTokenReceived, OnTokenReceivedInput, OnTokenReceivedOutput, requestPermissions, RequestPermissionsInput, setBadgeCount, SetBadgeCountInput, } from './providers/pinpoint';
+export { PushNotificationMessage } from './types';
+export { PushNotificationError } from './errors';

package/lib/pushNotifications/index.js

@@ -0,0 +1,19 @@
+"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.PushNotificationError = exports.setBadgeCount = exports.requestPermissions = exports.onTokenReceived = exports.onNotificationReceivedInForeground = exports.onNotificationReceivedInBackground = exports.onNotificationOpened = exports.initializePushNotifications = exports.identifyUser = exports.getPermissionStatus = exports.getLaunchNotification = exports.getBadgeCount = void 0;
+var pinpoint_1 = require("./providers/pinpoint");
+Object.defineProperty(exports, "getBadgeCount", { enumerable: true, get: function () { return pinpoint_1.getBadgeCount; } });
+Object.defineProperty(exports, "getLaunchNotification", { enumerable: true, get: function () { return pinpoint_1.getLaunchNotification; } });
+Object.defineProperty(exports, "getPermissionStatus", { enumerable: true, get: function () { return pinpoint_1.getPermissionStatus; } });
+Object.defineProperty(exports, "identifyUser", { enumerable: true, get: function () { return pinpoint_1.identifyUser; } });
+Object.defineProperty(exports, "initializePushNotifications", { enumerable: true, get: function () { return pinpoint_1.initializePushNotifications; } });
+Object.defineProperty(exports, "onNotificationOpened", { enumerable: true, get: function () { return pinpoint_1.onNotificationOpened; } });
+Object.defineProperty(exports, "onNotificationReceivedInBackground", { enumerable: true, get: function () { return pinpoint_1.onNotificationReceivedInBackground; } });
+Object.defineProperty(exports, "onNotificationReceivedInForeground", { enumerable: true, get: function () { return pinpoint_1.onNotificationReceivedInForeground; } });
+Object.defineProperty(exports, "onTokenReceived", { enumerable: true, get: function () { return pinpoint_1.onTokenReceived; } });
+Object.defineProperty(exports, "requestPermissions", { enumerable: true, get: function () { return pinpoint_1.requestPermissions; } });
+Object.defineProperty(exports, "setBadgeCount", { enumerable: true, get: function () { return pinpoint_1.setBadgeCount; } });
+var errors_1 = require("./errors");
+Object.defineProperty(exports, "PushNotificationError", { enumerable: true, get: function () { return errors_1.PushNotificationError; } });

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

@@ -0,0 +1,14 @@
+import { GetBadgeCount } from '../types';
+/**
+ * Returns the current badge count (the number next to 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.
+ * @returns A promise that resolves to a number representing the current count displayed on the app badge.
+ * @example
+ * ```ts
+ * const badgeCount = await getBadgeCount();
+ * ```
+ */
+export declare const getBadgeCount: GetBadgeCount;

package/lib/pushNotifications/providers/pinpoint/apis/getBadgeCount.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.getBadgeCount = void 0;
+const utils_1 = require("@aws-amplify/core/internals/utils");
+/**
+ * Returns the current badge count (the number next to 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.
+ * @returns A promise that resolves to a number representing the current count displayed on the app badge.
+ * @example
+ * ```ts
+ * const badgeCount = await getBadgeCount();
+ * ```
+ */
+const getBadgeCount = async () => {
+    throw new utils_1.PlatformNotSupportedError();
+};
+exports.getBadgeCount = getBadgeCount;

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

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

package/lib/pushNotifications/providers/pinpoint/apis/getBadgeCount.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.getBadgeCount = void 0;
+const react_native_1 = require("@aws-amplify/react-native");
+const errorHelpers_1 = require("../../../errors/errorHelpers");
+const { getBadgeCount: getBadgeCountNative } = (0, react_native_1.loadAmplifyPushNotification)();
+const getBadgeCount = async () => {
+    (0, errorHelpers_1.assertIsInitialized)();
+    return getBadgeCountNative();
+};
+exports.getBadgeCount = getBadgeCount;

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

@@ -0,0 +1,18 @@
+import { GetLaunchNotification } from '../types';
+/**
+ * Returns the notification which launched your app from a terminated state. The launch notification is consumed by
+ * calls to this function and will yield a null result if:
+ *   1. It is more than once (i.e. subsequent calls will be null)
+ *   2. Another notification was opened while your app was running (either in foreground or background)
+ *   3. Your app was brought back to the foreground by some other means (e.g. user tapped the app icon)
+ *
+ * @throws platform: {@link PlatformNotSupportedError} - Thrown if called against an unsupported platform. Currently,
+ * only React Native is supported by this API.
+ * @returns {Promise<GetLaunchNotificationOutput>} - a promise resolving to {@link PushNotificationMessage} if there is
+ * a launch notification and `null` otherwise.
+ * @example
+ * ```ts
+ * const launchNotification = await getLaunchNotification();
+ * ```
+ */
+export declare const getLaunchNotification: GetLaunchNotification;

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

@@ -0,0 +1,26 @@
+"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.getLaunchNotification = void 0;
+const utils_1 = require("@aws-amplify/core/internals/utils");
+/**
+ * Returns the notification which launched your app from a terminated state. The launch notification is consumed by
+ * calls to this function and will yield a null result if:
+ *   1. It is more than once (i.e. subsequent calls will be null)
+ *   2. Another notification was opened while your app was running (either in foreground or background)
+ *   3. Your app was brought back to the foreground by some other means (e.g. user tapped the app icon)
+ *
+ * @throws platform: {@link PlatformNotSupportedError} - Thrown if called against an unsupported platform. Currently,
+ * only React Native is supported by this API.
+ * @returns {Promise<GetLaunchNotificationOutput>} - a promise resolving to {@link PushNotificationMessage} if there is
+ * a launch notification and `null` otherwise.
+ * @example
+ * ```ts
+ * const launchNotification = await getLaunchNotification();
+ * ```
+ */
+const getLaunchNotification = async () => {
+    throw new utils_1.PlatformNotSupportedError();
+};
+exports.getLaunchNotification = getLaunchNotification;

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

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

package/lib/pushNotifications/providers/pinpoint/apis/getLaunchNotification.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.getLaunchNotification = void 0;
+const react_native_1 = require("@aws-amplify/react-native");
+const errorHelpers_1 = require("../../../errors/errorHelpers");
+const { getLaunchNotification: getLaunchNotificationNative } = (0, react_native_1.loadAmplifyPushNotification)();
+const getLaunchNotification = async () => {
+    (0, errorHelpers_1.assertIsInitialized)();
+    return getLaunchNotificationNative();
+};
+exports.getLaunchNotification = getLaunchNotification;

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

@@ -0,0 +1,27 @@
+import { GetPermissionStatus } from '../types';
+/**
+ * Returns a string representing the current status of user permissions to display push notifications. The possible
+ * statuses are as follows:
+ *
+ *   * `'shouldRequest'` - No permissions have been requested yet. It is idiomatic at this time to simply request for
+ *   permissions from the user.
+ *
+ *   * `'shouldExplainThenRequest'` - It is recommended at this time to provide some context or rationale to the user
+ *   explaining why you want to send them push notifications before requesting for permissions.
+ *
+ *   * `'granted'` - Permissions have been granted by the user. No further actions are needed and their app is ready to
+ *   display notifications.
+ *
+ *   * `'denied'` - Permissions have been denied by the user. Further attempts to request permissions will no longer
+ *   trigger a permission dialog. Your app should now either degrade gracefully or prompt your user to grant the
+ *   permissions needed in their device settings.
+ *
+ * @throws platform: {@link PlatformNotSupportedError} - Thrown if called against an unsupported platform. Currently,
+ * only React Native is supported by this API.
+ * @return {Promise<GetPermissionStatusOutput>} a promise resolving to a string representing the current status of user
+ * selected notification permissions.
+ * @example
+ * ```ts
+ * const permissionStatus = await getPermissionStatus();
+ */
+export declare const getPermissionStatus: GetPermissionStatus;

package/lib/pushNotifications/providers/pinpoint/apis/getPermissionStatus.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.getPermissionStatus = void 0;
+const utils_1 = require("@aws-amplify/core/internals/utils");
+/**
+ * Returns a string representing the current status of user permissions to display push notifications. The possible
+ * statuses are as follows:
+ *
+ *   * `'shouldRequest'` - No permissions have been requested yet. It is idiomatic at this time to simply request for
+ *   permissions from the user.
+ *
+ *   * `'shouldExplainThenRequest'` - It is recommended at this time to provide some context or rationale to the user
+ *   explaining why you want to send them push notifications before requesting for permissions.
+ *
+ *   * `'granted'` - Permissions have been granted by the user. No further actions are needed and their app is ready to
+ *   display notifications.
+ *
+ *   * `'denied'` - Permissions have been denied by the user. Further attempts to request permissions will no longer
+ *   trigger a permission dialog. Your app should now either degrade gracefully or prompt your user to grant the
+ *   permissions needed in their device settings.
+ *
+ * @throws platform: {@link PlatformNotSupportedError} - Thrown if called against an unsupported platform. Currently,
+ * only React Native is supported by this API.
+ * @return {Promise<GetPermissionStatusOutput>} a promise resolving to a string representing the current status of user
+ * selected notification permissions.
+ * @example
+ * ```ts
+ * const permissionStatus = await getPermissionStatus();
+ */
+const getPermissionStatus = async () => {
+    throw new utils_1.PlatformNotSupportedError();
+};
+exports.getPermissionStatus = getPermissionStatus;

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

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

package/lib/pushNotifications/providers/pinpoint/apis/getPermissionStatus.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.getPermissionStatus = void 0;
+const react_native_1 = require("@aws-amplify/react-native");
+const errorHelpers_1 = require("../../../errors/errorHelpers");
+const { getPermissionStatus: getPermissionStatusNative } = (0, react_native_1.loadAmplifyPushNotification)();
+const getPermissionStatus = async () => {
+    (0, errorHelpers_1.assertIsInitialized)();
+    return getPermissionStatusNative();
+};
+exports.getPermissionStatus = getPermissionStatus;

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

@@ -0,0 +1,53 @@
+import { IdentifyUser } from '../types';
+/**
+ * Sends information about a user to Pinpoint. Sending user information allows you to associate a user to their user
+ * profile and activities or actions in your application. Activity can be tracked across devices & platforms by using
+ * the same `userId`.
+ *
+ * @param {IdentifyUserInput} input The input object used to construct requests sent to Pinpoint's UpdateEndpoint
+ *  API.
+ * @throws service: {@link UpdateEndpointException} - Thrown when the underlying Pinpoint service returns an error.
+ * @throws validation: {@link PushNotificationValidationErrorCode} - Thrown when the provided parameters or library
+ *  configuration is incorrect.
+ * @throws platform: {@link PlatformNotSupportedError} - Thrown if called against an unsupported platform. Currently,
+ * only React Native is supported by this API.
+ * @returns A promise that will resolve when the operation is complete.
+ * @example
+ * ```ts
+ * // Identify a user with Pinpoint
+ * await identifyUser({
+ *     userId,
+ *     userProfile: {
+ *         email: 'userEmail@example.com'
+ *         customProperties: {
+ *             phoneNumber: ['555-555-5555'],
+ *         },
+ *     }
+ * });
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Identify a user with Pinpoint specific options
+ * await identifyUser({
+ *     userId,
+ *     userProfile: {
+ *         email: 'userEmail@example.com'
+ *         customProperties: {
+ *             phoneNumber: ['555-555-5555'],
+ *         },
+ *         demographic: {
+ *             platform: 'ios',
+ *             timezone: 'America/Los_Angeles'
+ *         }
+ *     },
+ *     options: {
+ *         address: 'device-address',
+ *         optOut: 'NONE',
+ *         userAttributes: {
+ *             interests: ['food']
+ *         },
+ *     },
+ * });
+ */
+export declare const identifyUser: IdentifyUser;

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

@@ -0,0 +1,61 @@
+"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.identifyUser = void 0;
+const utils_1 = require("@aws-amplify/core/internals/utils");
+/**
+ * Sends information about a user to Pinpoint. Sending user information allows you to associate a user to their user
+ * profile and activities or actions in your application. Activity can be tracked across devices & platforms by using
+ * the same `userId`.
+ *
+ * @param {IdentifyUserInput} input The input object used to construct requests sent to Pinpoint's UpdateEndpoint
+ *  API.
+ * @throws service: {@link UpdateEndpointException} - Thrown when the underlying Pinpoint service returns an error.
+ * @throws validation: {@link PushNotificationValidationErrorCode} - Thrown when the provided parameters or library
+ *  configuration is incorrect.
+ * @throws platform: {@link PlatformNotSupportedError} - Thrown if called against an unsupported platform. Currently,
+ * only React Native is supported by this API.
+ * @returns A promise that will resolve when the operation is complete.
+ * @example
+ * ```ts
+ * // Identify a user with Pinpoint
+ * await identifyUser({
+ *     userId,
+ *     userProfile: {
+ *         email: 'userEmail@example.com'
+ *         customProperties: {
+ *             phoneNumber: ['555-555-5555'],
+ *         },
+ *     }
+ * });
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Identify a user with Pinpoint specific options
+ * await identifyUser({
+ *     userId,
+ *     userProfile: {
+ *         email: 'userEmail@example.com'
+ *         customProperties: {
+ *             phoneNumber: ['555-555-5555'],
+ *         },
+ *         demographic: {
+ *             platform: 'ios',
+ *             timezone: 'America/Los_Angeles'
+ *         }
+ *     },
+ *     options: {
+ *         address: 'device-address',
+ *         optOut: 'NONE',
+ *         userAttributes: {
+ *             interests: ['food']
+ *         },
+ *     },
+ * });
+ */
+const identifyUser = async () => {
+    throw new utils_1.PlatformNotSupportedError();
+};
+exports.identifyUser = identifyUser;

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

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

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

@@ -0,0 +1,31 @@
+"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.identifyUser = void 0;
+const utils_1 = require("@aws-amplify/core/internals/utils");
+const pinpoint_1 = require("@aws-amplify/core/internals/providers/pinpoint");
+const errorHelpers_1 = require("../../../errors/errorHelpers");
+const utils_2 = require("../../../utils");
+const utils_3 = require("../utils");
+const identifyUser = async ({ userId, userProfile, options, }) => {
+    (0, errorHelpers_1.assertIsInitialized)();
+    const { credentials, identityId } = await (0, utils_2.resolveCredentials)();
+    const { appId, region } = (0, utils_3.resolveConfig)();
+    const { address, optOut, userAttributes } = options ?? {};
+    (0, pinpoint_1.updateEndpoint)({
+        address,
+        channelType: (0, utils_3.getChannelType)(),
+        optOut,
+        appId,
+        category: 'PushNotification',
+        credentials,
+        identityId,
+        region,
+        userAttributes,
+        userId,
+        userProfile,
+        userAgentValue: (0, utils_2.getPushNotificationUserAgentString)(utils_1.PushNotificationAction.IdentifyUser),
+    });
+};
+exports.identifyUser = identifyUser;

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

@@ -0,0 +1,11 @@
+export { getBadgeCount } from './getBadgeCount';
+export { getLaunchNotification } from './getLaunchNotification';
+export { getPermissionStatus } from './getPermissionStatus';
+export { identifyUser } from './identifyUser';
+export { initializePushNotifications } from './initializePushNotifications';
+export { onNotificationOpened } from './onNotificationOpened';
+export { onNotificationReceivedInBackground } from './onNotificationReceivedInBackground';
+export { onNotificationReceivedInForeground } from './onNotificationReceivedInForeground';
+export { onTokenReceived } from './onTokenReceived';
+export { requestPermissions } from './requestPermissions';
+export { setBadgeCount } from './setBadgeCount';

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

@@ -0,0 +1,27 @@
+"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 = exports.requestPermissions = exports.onTokenReceived = exports.onNotificationReceivedInForeground = exports.onNotificationReceivedInBackground = exports.onNotificationOpened = exports.initializePushNotifications = exports.identifyUser = exports.getPermissionStatus = exports.getLaunchNotification = exports.getBadgeCount = void 0;
+var getBadgeCount_1 = require("./getBadgeCount");
+Object.defineProperty(exports, "getBadgeCount", { enumerable: true, get: function () { return getBadgeCount_1.getBadgeCount; } });
+var getLaunchNotification_1 = require("./getLaunchNotification");
+Object.defineProperty(exports, "getLaunchNotification", { enumerable: true, get: function () { return getLaunchNotification_1.getLaunchNotification; } });
+var getPermissionStatus_1 = require("./getPermissionStatus");
+Object.defineProperty(exports, "getPermissionStatus", { enumerable: true, get: function () { return getPermissionStatus_1.getPermissionStatus; } });
+var identifyUser_1 = require("./identifyUser");
+Object.defineProperty(exports, "identifyUser", { enumerable: true, get: function () { return identifyUser_1.identifyUser; } });
+var initializePushNotifications_1 = require("./initializePushNotifications");
+Object.defineProperty(exports, "initializePushNotifications", { enumerable: true, get: function () { return initializePushNotifications_1.initializePushNotifications; } });
+var onNotificationOpened_1 = require("./onNotificationOpened");
+Object.defineProperty(exports, "onNotificationOpened", { enumerable: true, get: function () { return onNotificationOpened_1.onNotificationOpened; } });
+var onNotificationReceivedInBackground_1 = require("./onNotificationReceivedInBackground");
+Object.defineProperty(exports, "onNotificationReceivedInBackground", { enumerable: true, get: function () { return onNotificationReceivedInBackground_1.onNotificationReceivedInBackground; } });
+var onNotificationReceivedInForeground_1 = require("./onNotificationReceivedInForeground");
+Object.defineProperty(exports, "onNotificationReceivedInForeground", { enumerable: true, get: function () { return onNotificationReceivedInForeground_1.onNotificationReceivedInForeground; } });
+var onTokenReceived_1 = require("./onTokenReceived");
+Object.defineProperty(exports, "onTokenReceived", { enumerable: true, get: function () { return onTokenReceived_1.onTokenReceived; } });
+var requestPermissions_1 = require("./requestPermissions");
+Object.defineProperty(exports, "requestPermissions", { enumerable: true, get: function () { return requestPermissions_1.requestPermissions; } });
+var setBadgeCount_1 = require("./setBadgeCount");
+Object.defineProperty(exports, "setBadgeCount", { enumerable: true, get: function () { return setBadgeCount_1.setBadgeCount; } });

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

@@ -0,0 +1,17 @@
+import { InitializePushNotifications } from '../types';
+/**
+ * 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();
+ * ```
+ */
+export declare const initializePushNotifications: InitializePushNotifications;