@aws-amplify/notifications 1.6.6-unstable.7762f1a.0 → 2.0.0

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

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

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

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

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

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

@@ -0,0 +1,17 @@
+"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 apis_1 = require("./apis");
+Object.defineProperty(exports, "getBadgeCount", { enumerable: true, get: function () { return apis_1.getBadgeCount; } });
+Object.defineProperty(exports, "getLaunchNotification", { enumerable: true, get: function () { return apis_1.getLaunchNotification; } });
+Object.defineProperty(exports, "getPermissionStatus", { enumerable: true, get: function () { return apis_1.getPermissionStatus; } });
+Object.defineProperty(exports, "identifyUser", { enumerable: true, get: function () { return apis_1.identifyUser; } });
+Object.defineProperty(exports, "initializePushNotifications", { enumerable: true, get: function () { return apis_1.initializePushNotifications; } });
+Object.defineProperty(exports, "onNotificationOpened", { enumerable: true, get: function () { return apis_1.onNotificationOpened; } });
+Object.defineProperty(exports, "onNotificationReceivedInBackground", { enumerable: true, get: function () { return apis_1.onNotificationReceivedInBackground; } });
+Object.defineProperty(exports, "onNotificationReceivedInForeground", { enumerable: true, get: function () { return apis_1.onNotificationReceivedInForeground; } });
+Object.defineProperty(exports, "onTokenReceived", { enumerable: true, get: function () { return apis_1.onTokenReceived; } });
+Object.defineProperty(exports, "requestPermissions", { enumerable: true, get: function () { return apis_1.requestPermissions; } });
+Object.defineProperty(exports, "setBadgeCount", { enumerable: true, get: function () { return apis_1.setBadgeCount; } });

package/lib/pushNotifications/providers/pinpoint/types/analytics.d.ts

@@ -0,0 +1,6 @@
+export type PinpointMessageEvent = 'opened_notification' | 'received_background' | 'received_foreground';
+export type PinpointMessageEventSource = '_campaign' | '_journey';
+export type AnalyticsEventAttributes = {
+    source: PinpointMessageEventSource;
+    attributes: Record<string, string>;
+};

package/lib/pushNotifications/providers/pinpoint/types/analytics.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,13 @@
+import { IdentifyUserInput, OnNotificationOpenedInput, OnNotificationReceivedInBackgroundInput, OnNotificationReceivedInForegroundInput, OnTokenReceivedInput, RequestPermissionsInput, SetBadgeCountInput } from './inputs';
+import { GetBadgeCountOutput, GetLaunchNotificationOutput, GetPermissionStatusOutput, OnNotificationOpenedOutput, OnNotificationReceivedInBackgroundOutput, OnNotificationReceivedInForegroundOutput, OnTokenReceivedOutput, RequestPermissionsOutput } from './outputs';
+export type GetBadgeCount = () => Promise<void | GetBadgeCountOutput>;
+export type GetLaunchNotification = () => Promise<GetLaunchNotificationOutput>;
+export type GetPermissionStatus = () => Promise<GetPermissionStatusOutput>;
+export type IdentifyUser = (input: IdentifyUserInput) => Promise<void>;
+export type InitializePushNotifications = () => void;
+export type RequestPermissions = (input?: RequestPermissionsInput) => Promise<RequestPermissionsOutput>;
+export type SetBadgeCount = (input: SetBadgeCountInput) => void;
+export type OnNotificationOpened = (input: OnNotificationOpenedInput) => OnNotificationOpenedOutput;
+export type OnNotificationReceivedInBackground = (input: OnNotificationReceivedInBackgroundInput) => OnNotificationReceivedInBackgroundOutput;
+export type OnNotificationReceivedInForeground = (input: OnNotificationReceivedInForegroundInput) => OnNotificationReceivedInForegroundOutput;
+export type OnTokenReceived = (input: OnTokenReceivedInput) => OnTokenReceivedOutput;

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

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,6 @@
+export { AnalyticsEventAttributes, PinpointMessageEvent, PinpointMessageEventSource, } from './analytics';
+export { GetBadgeCount, GetLaunchNotification, GetPermissionStatus, IdentifyUser, InitializePushNotifications, OnNotificationOpened, OnNotificationReceivedInBackground, OnNotificationReceivedInForeground, OnTokenReceived, RequestPermissions, SetBadgeCount, } from './apis';
+export { IdentifyUserInput, OnNotificationOpenedInput, OnNotificationReceivedInBackgroundInput, OnNotificationReceivedInForegroundInput, OnTokenReceivedInput, RequestPermissionsInput, SetBadgeCountInput, } from './inputs';
+export { GetLaunchNotificationOutput, GetPermissionStatusOutput, OnNotificationOpenedOutput, OnNotificationReceivedInBackgroundOutput, OnNotificationReceivedInForegroundOutput, OnTokenReceivedOutput, } from './outputs';
+export { IdentifyUserOptions } from './options';
+export { ChannelType } from './pushNotifications';

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

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/pushNotifications/providers/pinpoint/types/inputs.d.ts

@@ -0,0 +1,9 @@
+import { IdentifyUserOptions } from './options';
+import { PushNotificationIdentifyUserInput, PushNotificationRequestPermissionsInput, PushNotificationSetBadgeCountInput, PushNotificationOnNotificationOpenedInput, PushNotificationOnNotificationReceivedInBackgroundInput, PushNotificationOnNotificationReceivedInForegroundInput, PushNotificationOnTokenReceivedInput } from '../../../types';
+export type IdentifyUserInput = PushNotificationIdentifyUserInput<IdentifyUserOptions>;
+export type RequestPermissionsInput = PushNotificationRequestPermissionsInput;
+export type SetBadgeCountInput = PushNotificationSetBadgeCountInput;
+export type OnNotificationOpenedInput = PushNotificationOnNotificationOpenedInput;
+export type OnNotificationReceivedInBackgroundInput = PushNotificationOnNotificationReceivedInBackgroundInput;
+export type OnNotificationReceivedInForegroundInput = PushNotificationOnNotificationReceivedInForegroundInput;
+export type OnTokenReceivedInput = PushNotificationOnTokenReceivedInput;

package/lib/pushNotifications/providers/pinpoint/types/inputs.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/pushNotifications/providers/pinpoint/types/options.d.ts

@@ -0,0 +1,5 @@
+import { PinpointServiceOptions } from '@aws-amplify/core/internals/providers/pinpoint';
+/**
+ * Options specific to Pinpoint identityUser.
+ */
+export type IdentifyUserOptions = PinpointServiceOptions;

package/lib/pushNotifications/providers/pinpoint/types/options.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/pushNotifications/providers/pinpoint/types/outputs.d.ts

@@ -0,0 +1,9 @@
+import { PushNotificationGetBadgeCountOutput, PushNotificationGetLaunchNotificationOutput, PushNotificationGetPermissionStatusOutput, PushNotificationOnNotificationOpenedOutput, PushNotificationOnNotificationReceivedInBackgroundOutput, PushNotificationOnNotificationReceivedInForegroundOutput, PushNotificationOnTokenReceivedOutput, PushNotificationRequestPermissionsOutput } from '../../../types';
+export type GetBadgeCountOutput = PushNotificationGetBadgeCountOutput;
+export type GetLaunchNotificationOutput = PushNotificationGetLaunchNotificationOutput;
+export type GetPermissionStatusOutput = PushNotificationGetPermissionStatusOutput;
+export type RequestPermissionsOutput = PushNotificationRequestPermissionsOutput;
+export type OnNotificationOpenedOutput = PushNotificationOnNotificationOpenedOutput;
+export type OnNotificationReceivedInBackgroundOutput = PushNotificationOnNotificationReceivedInBackgroundOutput;
+export type OnNotificationReceivedInForegroundOutput = PushNotificationOnNotificationReceivedInForegroundOutput;
+export type OnTokenReceivedOutput = PushNotificationOnTokenReceivedOutput;

package/lib/pushNotifications/providers/pinpoint/types/outputs.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/pushNotifications/providers/pinpoint/types/pushNotifications.d.ts

@@ -0,0 +1,2 @@
+import { updateEndpoint } from '@aws-amplify/core/internals/providers/pinpoint';
+export type ChannelType = Parameters<typeof updateEndpoint>[0]['channelType'];

package/lib/pushNotifications/providers/pinpoint/types/pushNotifications.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/pushNotifications/providers/pinpoint/utils/createMessageEventRecorder.d.ts

@@ -0,0 +1,6 @@
+import { PinpointMessageEvent } from '../types';
+import { OnPushNotificationMessageHandler } from '../../../types';
+/**
+ * @internal
+ */
+export declare const createMessageEventRecorder: (event: PinpointMessageEvent, callback?: Function) => OnPushNotificationMessageHandler;

package/lib/pushNotifications/providers/pinpoint/utils/createMessageEventRecorder.js

@@ -0,0 +1,43 @@
+"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.createMessageEventRecorder = void 0;
+const pinpoint_1 = require("@aws-amplify/core/internals/providers/pinpoint");
+const core_1 = require("@aws-amplify/core");
+const utils_1 = require("../../../utils");
+const getAnalyticsEvent_1 = require("./getAnalyticsEvent");
+const getChannelType_1 = require("./getChannelType");
+const resolveConfig_1 = require("./resolveConfig");
+const logger = new core_1.ConsoleLogger('PushNotification.recordMessageEvent');
+/**
+ * @internal
+ */
+const createMessageEventRecorder = (event, callback) => async (message) => {
+    const { credentials } = await (0, utils_1.resolveCredentials)();
+    const { appId, region } = (0, resolveConfig_1.resolveConfig)();
+    await recordMessageEvent({
+        appId,
+        credentials,
+        event,
+        message,
+        region,
+    });
+    callback?.();
+};
+exports.createMessageEventRecorder = createMessageEventRecorder;
+const recordMessageEvent = async ({ appId, credentials, event, message, region, }) => {
+    const analyticsEvent = (0, getAnalyticsEvent_1.getAnalyticsEvent)(message, event);
+    if (!analyticsEvent) {
+        logger.debug('A notification missing event information was not recorded');
+        return;
+    }
+    return (0, pinpoint_1.record)({
+        appId,
+        category: 'PushNotification',
+        channelType: (0, getChannelType_1.getChannelType)(),
+        credentials,
+        event: analyticsEvent,
+        region,
+    });
+};

package/lib/pushNotifications/providers/pinpoint/utils/getAnalyticsEvent.d.ts

@@ -0,0 +1,7 @@
+import { PinpointAnalyticsEvent } from '@aws-amplify/core/internals/providers/pinpoint';
+import { PinpointMessageEvent } from '../types';
+import { PushNotificationMessage } from '../../../types';
+/**
+ * @internal
+ */
+export declare const getAnalyticsEvent: ({ data }: PushNotificationMessage, event: PinpointMessageEvent) => PinpointAnalyticsEvent | null;

package/lib/pushNotifications/providers/pinpoint/utils/getAnalyticsEvent.js

@@ -0,0 +1,56 @@
+"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.getAnalyticsEvent = void 0;
+const ANDROID_CAMPAIGN_ACTIVITY_ID_KEY = 'pinpoint.campaign.campaign_activity_id';
+const ANDROID_CAMPAIGN_ID_KEY = 'pinpoint.campaign.campaign_id';
+const ANDROID_CAMPAIGN_TREATMENT_ID_KEY = 'pinpoint.campaign.treatment_id';
+/**
+ * @internal
+ */
+const getAnalyticsEvent = ({ data }, event) => {
+    if (!data) {
+        return null;
+    }
+    const eventAttributes = getAnalyticsEventAttributes(data);
+    if (!eventAttributes) {
+        return null;
+    }
+    const { source, attributes } = eventAttributes;
+    return {
+        attributes,
+        name: `${source}.${event}`,
+    };
+};
+exports.getAnalyticsEvent = getAnalyticsEvent;
+const getAnalyticsEventAttributes = (data) => {
+    if (!data) {
+        return;
+    }
+    if (data.hasOwnProperty(ANDROID_CAMPAIGN_ID_KEY)) {
+        return {
+            source: '_campaign',
+            attributes: {
+                campaign_activity_id: data[ANDROID_CAMPAIGN_ACTIVITY_ID_KEY],
+                campaign_id: data[ANDROID_CAMPAIGN_ID_KEY],
+                treatment_id: data[ANDROID_CAMPAIGN_TREATMENT_ID_KEY],
+            },
+        };
+    }
+    const pinpoint = typeof data.pinpoint === 'string'
+        ? JSON.parse(data.pinpoint)
+        : data.pinpoint;
+    if (pinpoint?.campaign) {
+        return {
+            source: '_campaign',
+            attributes: pinpoint.campaign,
+        };
+    }
+    if (pinpoint?.journey) {
+        return {
+            source: '_journey',
+            attributes: pinpoint.journey,
+        };
+    }
+};

package/lib/pushNotifications/providers/pinpoint/utils/getChannelType.d.ts

@@ -0,0 +1,5 @@
+import { ChannelType } from '../types';
+/**
+ * @internal
+ */
+export declare const getChannelType: () => ChannelType;

package/lib/pushNotifications/providers/pinpoint/utils/getChannelType.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.getChannelType = void 0;
+const utils_1 = require("@aws-amplify/core/internals/utils");
+const react_native_1 = require("@aws-amplify/react-native");
+const operatingSystem = (0, react_native_1.getOperatingSystem)();
+const isAndroid = operatingSystem === 'android';
+const isIos = operatingSystem === 'ios';
+/**
+ * @internal
+ */
+const getChannelType = () => {
+    if (isAndroid) {
+        // FCM was previously known as GCM and continues to be the channel type in Pinpoint
+        return 'GCM';
+    }
+    if (isIos) {
+        // If building in debug mode, use the APNs sandbox
+        return __DEV__ ? 'APNS_SANDBOX' : 'APNS';
+    }
+    throw new utils_1.PlatformNotSupportedError();
+};
+exports.getChannelType = getChannelType;

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

@@ -0,0 +1,4 @@
+export { createMessageEventRecorder } from './createMessageEventRecorder';
+export { getAnalyticsEvent } from './getAnalyticsEvent';
+export { getChannelType } from './getChannelType';
+export { resolveConfig } from './resolveConfig';

package/lib/pushNotifications/providers/pinpoint/utils/index.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.resolveConfig = exports.getChannelType = exports.getAnalyticsEvent = exports.createMessageEventRecorder = void 0;
+var createMessageEventRecorder_1 = require("./createMessageEventRecorder");
+Object.defineProperty(exports, "createMessageEventRecorder", { enumerable: true, get: function () { return createMessageEventRecorder_1.createMessageEventRecorder; } });
+var getAnalyticsEvent_1 = require("./getAnalyticsEvent");
+Object.defineProperty(exports, "getAnalyticsEvent", { enumerable: true, get: function () { return getAnalyticsEvent_1.getAnalyticsEvent; } });
+var getChannelType_1 = require("./getChannelType");
+Object.defineProperty(exports, "getChannelType", { enumerable: true, get: function () { return getChannelType_1.getChannelType; } });
+var resolveConfig_1 = require("./resolveConfig");
+Object.defineProperty(exports, "resolveConfig", { enumerable: true, get: function () { return resolveConfig_1.resolveConfig; } });

package/lib/pushNotifications/providers/pinpoint/utils/resolveConfig.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @internal
+ */
+export declare const resolveConfig: () => {
+    appId: string;
+    region: string;
+};

package/lib/pushNotifications/providers/pinpoint/utils/resolveConfig.js

@@ -0,0 +1,17 @@
+"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.resolveConfig = void 0;
+const core_1 = require("@aws-amplify/core");
+const errors_1 = require("../../../errors");
+/**
+ * @internal
+ */
+const resolveConfig = () => {
+    const { appId, region } = core_1.Amplify.getConfig().Notifications?.PushNotification?.Pinpoint ?? {};
+    (0, errors_1.assert)(!!appId, errors_1.PushNotificationValidationErrorCode.NoAppId);
+    (0, errors_1.assert)(!!region, errors_1.PushNotificationValidationErrorCode.NoRegion);
+    return { appId, region };
+};
+exports.resolveConfig = resolveConfig;

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

@@ -0,0 +1,3 @@
+export declare enum PushNotificationErrorCode {
+    NotInitialized = "NotInitialized"
+}

package/lib/pushNotifications/types/errors.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.PushNotificationErrorCode = void 0;
+var PushNotificationErrorCode;
+(function (PushNotificationErrorCode) {
+    PushNotificationErrorCode["NotInitialized"] = "NotInitialized";
+})(PushNotificationErrorCode = exports.PushNotificationErrorCode || (exports.PushNotificationErrorCode = {}));

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

@@ -0,0 +1,6 @@
+export * from './errors';
+export * from './inputs';
+export * from './module';
+export * from './options';
+export * from './outputs';
+export * from './pushNotifications';

package/lib/pushNotifications/types/index.js

@@ -0,0 +1,24 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./errors"), exports);
+__exportStar(require("./inputs"), exports);
+__exportStar(require("./module"), exports);
+__exportStar(require("./options"), exports);
+__exportStar(require("./outputs"), exports);
+__exportStar(require("./pushNotifications"), exports);

package/lib/pushNotifications/types/inputs.d.ts

@@ -0,0 +1,24 @@
+import { UserProfile } from '@aws-amplify/core';
+import { PushNotificationServiceOptions } from './options';
+import { PushNotificationPermissions } from './module';
+import { OnPushNotificationMessageHandler, OnTokenReceivedHandler } from './pushNotifications';
+export type PushNotificationIdentifyUserInput<ServiceOptions extends PushNotificationServiceOptions = PushNotificationServiceOptions> = {
+    /**
+     * A User ID associated to the current device.
+     */
+    userId: string;
+    /**
+     * Additional information about the user and their device.
+     */
+    userProfile: UserProfile;
+    /**
+     * Options to be passed to the API.
+     */
+    options?: ServiceOptions;
+};
+export type PushNotificationRequestPermissionsInput = PushNotificationPermissions;
+export type PushNotificationSetBadgeCountInput = number;
+export type PushNotificationOnNotificationOpenedInput = OnPushNotificationMessageHandler;
+export type PushNotificationOnNotificationReceivedInBackgroundInput = OnPushNotificationMessageHandler;
+export type PushNotificationOnNotificationReceivedInForegroundInput = OnPushNotificationMessageHandler;
+export type PushNotificationOnTokenReceivedInput = OnTokenReceivedHandler;

package/lib/pushNotifications/types/inputs.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/pushNotifications/types/module.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Types here are duplicated from `rtn-push-notifications` as it is not possible to share a source of truth
+ * with a package that may conditionally not exist for developers not using push notifications. Modifications
+ * made to these types should be reflected in the native module package and vice-versa!
+ */
+interface ApnsPlatformOptions {
+    subtitle?: string;
+}
+interface FcmPlatformOptions {
+    channelId: string;
+    messageId: string;
+    senderId: string;
+    sendTime: Date;
+}
+export interface PushNotificationMessage {
+    title?: string;
+    body?: string;
+    imageUrl?: string;
+    deeplinkUrl?: string;
+    goToUrl?: string;
+    fcmOptions?: FcmPlatformOptions;
+    apnsOptions?: ApnsPlatformOptions;
+    data?: Record<string, unknown>;
+}
+export type PushNotificationPermissionStatus = 'denied' | 'granted' | 'shouldRequest' | 'shouldExplainThenRequest';
+export interface PushNotificationPermissions extends Partial<Record<string, boolean>> {
+    alert?: boolean;
+    badge?: boolean;
+    sound?: boolean;
+}
+export {};

package/lib/pushNotifications/types/module.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/pushNotifications/types/options.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Base type for service options.
+ */
+export type PushNotificationServiceOptions = Record<string, unknown>;

package/lib/pushNotifications/types/options.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/pushNotifications/types/outputs.d.ts

@@ -0,0 +1,10 @@
+import { EventListenerRemover } from '../../eventListeners';
+import { PushNotificationMessage, PushNotificationPermissionStatus } from '../types';
+export type PushNotificationGetBadgeCountOutput = number | null;
+export type PushNotificationGetLaunchNotificationOutput = PushNotificationMessage | null;
+export type PushNotificationGetPermissionStatusOutput = PushNotificationPermissionStatus;
+export type PushNotificationRequestPermissionsOutput = boolean;
+export type PushNotificationOnNotificationOpenedOutput = EventListenerRemover;
+export type PushNotificationOnNotificationReceivedInBackgroundOutput = EventListenerRemover;
+export type PushNotificationOnNotificationReceivedInForegroundOutput = EventListenerRemover;
+export type PushNotificationOnTokenReceivedOutput = EventListenerRemover;

package/lib/pushNotifications/types/outputs.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/pushNotifications/types/pushNotifications.d.ts

@@ -0,0 +1,4 @@
+import { PushNotificationMessage } from './module';
+export type OnTokenReceivedHandler = (token: string) => void;
+export type OnPushNotificationMessageHandler = (message: PushNotificationMessage) => void;
+export type PushNotificationEvent = 'backgroundMessageReceived' | 'foregroundMessageReceived' | 'launchNotificationOpened' | 'notificationOpened' | 'tokenReceived';

package/lib/pushNotifications/types/pushNotifications.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/pushNotifications/utils/getPushNotificationUserAgentString.d.ts

@@ -0,0 +1,2 @@
+import { PushNotificationAction } from '@aws-amplify/core/internals/utils';
+export declare const getPushNotificationUserAgentString: (action: PushNotificationAction) => string;

package/lib/pushNotifications/utils/getPushNotificationUserAgentString.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPushNotificationUserAgentString = void 0;
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+const utils_1 = require("@aws-amplify/core/internals/utils");
+const getPushNotificationUserAgentString = (action) => (0, utils_1.getAmplifyUserAgent)({
+    category: utils_1.Category.PushNotification,
+    action,
+});
+exports.getPushNotificationUserAgentString = getPushNotificationUserAgentString;

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

@@ -0,0 +1,4 @@
+export { getPushNotificationUserAgentString } from './getPushNotificationUserAgentString';
+export { initialize, isInitialized } from './initializationManager';
+export { resolveCredentials } from './resolveCredentials';
+export { getToken, setToken } from './tokenManager';

package/lib/pushNotifications/utils/index.js

@@ -0,0 +1,15 @@
+"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.setToken = exports.getToken = exports.resolveCredentials = exports.isInitialized = exports.initialize = exports.getPushNotificationUserAgentString = void 0;
+var getPushNotificationUserAgentString_1 = require("./getPushNotificationUserAgentString");
+Object.defineProperty(exports, "getPushNotificationUserAgentString", { enumerable: true, get: function () { return getPushNotificationUserAgentString_1.getPushNotificationUserAgentString; } });
+var initializationManager_1 = require("./initializationManager");
+Object.defineProperty(exports, "initialize", { enumerable: true, get: function () { return initializationManager_1.initialize; } });
+Object.defineProperty(exports, "isInitialized", { enumerable: true, get: function () { return initializationManager_1.isInitialized; } });
+var resolveCredentials_1 = require("./resolveCredentials");
+Object.defineProperty(exports, "resolveCredentials", { enumerable: true, get: function () { return resolveCredentials_1.resolveCredentials; } });
+var tokenManager_1 = require("./tokenManager");
+Object.defineProperty(exports, "getToken", { enumerable: true, get: function () { return tokenManager_1.getToken; } });
+Object.defineProperty(exports, "setToken", { enumerable: true, get: function () { return tokenManager_1.setToken; } });

package/lib/pushNotifications/utils/initializationManager.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Sets initialization status to true.
+ *
+ * @internal
+ */
+export declare const initialize: () => Promise<void>;
+/**
+ * Returns the initialization status of push notifications.
+ *
+ * @internal
+ */
+export declare const isInitialized: () => boolean;

package/lib/pushNotifications/utils/initializationManager.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.isInitialized = exports.initialize = void 0;
+let initialized = false;
+/**
+ * Sets initialization status to true.
+ *
+ * @internal
+ */
+const initialize = async () => {
+    initialized = true;
+};
+exports.initialize = initialize;
+/**
+ * Returns the initialization status of push notifications.
+ *
+ * @internal
+ */
+const isInitialized = () => initialized;
+exports.isInitialized = isInitialized;

package/lib/pushNotifications/utils/resolveCredentials.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @internal
+ */
+export declare const resolveCredentials: () => Promise<{
+    credentials: import("@aws-amplify/core/lib-esm/libraryUtils").AWSCredentials;
+    identityId: string | undefined;
+}>;

package/lib/pushNotifications/utils/resolveCredentials.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.resolveCredentials = void 0;
+const core_1 = require("@aws-amplify/core");
+const errors_1 = require("../errors");
+/**
+ * @internal
+ */
+const resolveCredentials = async () => {
+    const { credentials, identityId } = await (0, core_1.fetchAuthSession)();
+    (0, errors_1.assert)(!!credentials, errors_1.PushNotificationValidationErrorCode.NoCredentials);
+    return { credentials, identityId };
+};
+exports.resolveCredentials = resolveCredentials;