@aws-amplify/notifications 2.0.1-console-preview.8f82e46.0 → 2.0.1-console-preview.b278dcb.0

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

@@ -0,0 +1,57 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { __awaiter, __generator } from "tslib";
+import { record } from '@aws-amplify/core/internals/providers/pinpoint';
+import { ConsoleLogger } from '@aws-amplify/core';
+import { getAnalyticsEvent } from './getAnalyticsEvent';
+import { getChannelType } from './getChannelType';
+import { resolveConfig, resolveCredentials } from '../../../utils';
+var logger = new ConsoleLogger('PushNotification.recordMessageEvent');
+/**
+ * @internal
+ */
+export var createMessageEventRecorder = function (event, callback) {
+    return function (message) { return __awaiter(void 0, void 0, void 0, function () {
+        var credentials, _a, appId, region;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0: return [4 /*yield*/, resolveCredentials()];
+                case 1:
+                    credentials = (_b.sent()).credentials;
+                    _a = resolveConfig(), appId = _a.appId, region = _a.region;
+                    return [4 /*yield*/, recordMessageEvent({
+                            appId: appId,
+                            credentials: credentials,
+                            event: event,
+                            message: message,
+                            region: region,
+                        })];
+                case 2:
+                    _b.sent();
+                    callback === null || callback === void 0 ? void 0 : callback();
+                    return [2 /*return*/];
+            }
+        });
+    }); };
+};
+var recordMessageEvent = function (_a) {
+    var appId = _a.appId, credentials = _a.credentials, event = _a.event, message = _a.message, region = _a.region;
+    return __awaiter(void 0, void 0, void 0, function () {
+        var analyticsEvent;
+        return __generator(this, function (_b) {
+            analyticsEvent = getAnalyticsEvent(message, event);
+            if (!analyticsEvent) {
+                logger.debug('A notification missing event information was not recorded');
+                return [2 /*return*/];
+            }
+            return [2 /*return*/, record({
+                    appId: appId,
+                    category: 'PushNotification',
+                    channelType: getChannelType(),
+                    credentials: credentials,
+                    event: analyticsEvent,
+                    region: region,
+                })];
+        });
+    });
+};

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

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

package/lib-esm/pushNotifications/providers/{AWSPinpointProvider/utils.js → pinpoint/utils/getAnalyticsEvent.js}

@@ -1,11 +1,11 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { ConsoleLogger } from '@aws-amplify/core/internals/utils';
-import { AWSPinpointMessageEventSource, } from './types';
 var ANDROID_CAMPAIGN_ACTIVITY_ID_KEY = 'pinpoint.campaign.campaign_activity_id';
 var ANDROID_CAMPAIGN_ID_KEY = 'pinpoint.campaign.campaign_id';
 var ANDROID_CAMPAIGN_TREATMENT_ID_KEY = 'pinpoint.campaign.treatment_id';
-export var logger = new ConsoleLogger('PushNotification.AWSPinpointProvider');
+/**
+ * @internal
+ */
 export var getAnalyticsEvent = function (_a, event) {
     var data = _a.data;
     if (!data) {
@@ -17,15 +17,14 @@ export var getAnalyticsEvent = function (_a, event) {
     }
     var source = eventAttributes.source, attributes = eventAttributes.attributes;
     return {
-        Attributes: attributes,
-        EventType: source + "." + event,
-        Timestamp: new Date().toISOString(),
+        attributes: attributes,
+        name: source + "." + event,
     };
 };
 var getAnalyticsEventAttributes = function (data) {
     if (data.hasOwnProperty(ANDROID_CAMPAIGN_ID_KEY)) {
         return {
-            source: AWSPinpointMessageEventSource.CAMPAIGN,
+            source: '_campaign',
             attributes: {
                 campaign_activity_id: data[ANDROID_CAMPAIGN_ACTIVITY_ID_KEY],
                 campaign_id: data[ANDROID_CAMPAIGN_ID_KEY],
@@ -38,15 +37,14 @@ var getAnalyticsEventAttributes = function (data) {
         : data.pinpoint;
     if (pinpoint === null || pinpoint === void 0 ? void 0 : pinpoint.campaign) {
         return {
-            source: AWSPinpointMessageEventSource.CAMPAIGN,
+            source: '_campaign',
             attributes: pinpoint.campaign,
         };
     }
     if (pinpoint === null || pinpoint === void 0 ? void 0 : pinpoint.journey) {
         return {
-            source: AWSPinpointMessageEventSource.JOURNEY,
+            source: '_journey',
             attributes: pinpoint.journey,
         };
     }
 };
-//# sourceMappingURL=utils.js.map

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

@@ -0,0 +1,4 @@
+/**
+ * @internal
+ */
+export declare const getChannelType: () => "IN_APP" | "APNS" | "APNS_SANDBOX" | "GCM";

package/lib-esm/pushNotifications/providers/pinpoint/utils/getChannelType.js

@@ -0,0 +1,21 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { PlatformNotSupportedError } from '@aws-amplify/core/internals/utils';
+import { getOperatingSystem } from '@aws-amplify/react-native';
+var operatingSystem = getOperatingSystem();
+var isAndroid = operatingSystem === 'android';
+var isIos = operatingSystem === 'ios';
+/**
+ * @internal
+ */
+export var getChannelType = function () {
+    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 global['__DEV__'] ? 'APNS_SANDBOX' : 'APNS';
+    }
+    throw new PlatformNotSupportedError();
+};

package/lib-esm/pushNotifications/providers/pinpoint/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-esm/pushNotifications/providers/pinpoint/utils/getPushNotificationUserAgentString.js

@@ -0,0 +1,9 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { Category, getAmplifyUserAgent, } from '@aws-amplify/core/internals/utils';
+export var getPushNotificationUserAgentString = function (action) {
+    return getAmplifyUserAgent({
+        category: Category.PushNotification,
+        action: action,
+    });
+};

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

@@ -0,0 +1,3 @@
+export { createMessageEventRecorder } from './createMessageEventRecorder';
+export { getChannelType } from './getChannelType';
+export { getPushNotificationUserAgentString } from './getPushNotificationUserAgentString';

package/lib-esm/pushNotifications/providers/pinpoint/utils/index.js

@@ -0,0 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export { createMessageEventRecorder } from './createMessageEventRecorder';
+export { getChannelType } from './getChannelType';
+export { getPushNotificationUserAgentString } from './getPushNotificationUserAgentString';

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

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

package/lib-esm/pushNotifications/types/errors.js

@@ -0,0 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export var PushNotificationErrorCode;
+(function (PushNotificationErrorCode) {
+    PushNotificationErrorCode["NotInitialized"] = "NotInitialized";
+})(PushNotificationErrorCode || (PushNotificationErrorCode = {}));

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

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

package/lib-esm/pushNotifications/types/index.js

@@ -0,0 +1,3 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export * from './errors';

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

@@ -0,0 +1,23 @@
+import { UserProfile } from '@aws-amplify/core';
+import { PushNotificationServiceOptions } from './options';
+import { OnPushNotificationMessageHandler, OnTokenReceivedHandler, PushNotificationPermissions } from './pushNotifications';
+export declare 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 declare type PushNotificationRequestPermissionsInput = PushNotificationPermissions;
+export declare type PushNotificationSetBadgeCountInput = number;
+export declare type PushNotificationOnNotificationOpenedInput = OnPushNotificationMessageHandler;
+export declare type PushNotificationOnNotificationReceivedInBackgroundInput = OnPushNotificationMessageHandler;
+export declare type PushNotificationOnNotificationReceivedInForegroundInput = OnPushNotificationMessageHandler;
+export declare type PushNotificationOnTokenReceivedInput = OnTokenReceivedHandler;

package/lib-esm/pushNotifications/types/inputs.js

@@ -0,0 +1,2 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0

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

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

package/lib-esm/pushNotifications/types/options.js

@@ -0,0 +1,2 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0

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

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

package/lib-esm/pushNotifications/types/outputs.js

@@ -0,0 +1,2 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0

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

@@ -0,0 +1,5 @@
+import type { PushNotificationMessage } from '@aws-amplify/react-native';
+export type { PushNotificationMessage, PushNotificationPermissionStatus, PushNotificationPermissions, } from '@aws-amplify/react-native';
+export declare type OnTokenReceivedHandler = (token: string) => void;
+export declare type OnPushNotificationMessageHandler = (message: PushNotificationMessage) => void;
+export declare type PushNotificationEvent = 'backgroundMessageReceived' | 'foregroundMessageReceived' | 'launchNotificationsOpened' | 'notificationOpened' | 'tokenReceived';

package/lib-esm/pushNotifications/types/pushNotifications.js

@@ -0,0 +1,2 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0

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

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

package/lib-esm/pushNotifications/utils/index.js

@@ -0,0 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export { initialize, isInitialized } from './initializationManager';
+export { resolveConfig } from './resolveConfig';
+export { resolveCredentials } from './resolveCredentials';
+export { getToken, setToken } from './tokenManager';

package/lib-esm/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-esm/pushNotifications/utils/initializationManager.js

@@ -0,0 +1,21 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { __awaiter, __generator } from "tslib";
+var initialized = false;
+/**
+ * Sets initialization status to true.
+ *
+ * @internal
+ */
+export var initialize = function () { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        initialized = true;
+        return [2 /*return*/];
+    });
+}); };
+/**
+ * Returns the initialization status of push notifications.
+ *
+ * @internal
+ */
+export var isInitialized = function () { return initialized; };

package/lib-esm/pushNotifications/utils/resolveConfig.d.ts

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

package/lib-esm/pushNotifications/utils/resolveConfig.js

@@ -0,0 +1,14 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { Amplify } from '@aws-amplify/core';
+import { assert, PushNotificationValidationErrorCode } from '../errors';
+/**
+ * @internal
+ */
+export var resolveConfig = function () {
+    var _a, _b;
+    var _c = (_b = (_a = Amplify.getConfig().Notifications) === null || _a === void 0 ? void 0 : _a.PushNotification.Pinpoint) !== null && _b !== void 0 ? _b : {}, appId = _c.appId, region = _c.region;
+    assert(!!appId, PushNotificationValidationErrorCode.NoAppId);
+    assert(!!region, PushNotificationValidationErrorCode.NoRegion);
+    return { appId: appId, region: region };
+};

package/lib-esm/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;
+}>;

package/lib-esm/pushNotifications/utils/resolveCredentials.js

@@ -0,0 +1,20 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { __awaiter, __generator } from "tslib";
+import { fetchAuthSession } from '@aws-amplify/core';
+import { assert, PushNotificationValidationErrorCode } from '../errors';
+/**
+ * @internal
+ */
+export var resolveCredentials = function () { return __awaiter(void 0, void 0, void 0, function () {
+    var _a, credentials, identityId;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
+            case 0: return [4 /*yield*/, fetchAuthSession()];
+            case 1:
+                _a = _b.sent(), credentials = _a.credentials, identityId = _a.identityId;
+                assert(!!credentials, PushNotificationValidationErrorCode.NoCredentials);
+                return [2 /*return*/, { credentials: credentials, identityId: identityId }];
+        }
+    });
+}); };

package/lib-esm/pushNotifications/utils/tokenManager.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Sets token.
+ *
+ * @internal
+ */
+export declare const setToken: (newToken: string) => void;
+/**
+ * Returns the current token.
+ *
+ * @internal
+ */
+export declare const getToken: () => string;

package/lib-esm/pushNotifications/utils/tokenManager.js

@@ -0,0 +1,17 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+var token;
+/**
+ * Sets token.
+ *
+ * @internal
+ */
+export var setToken = function (newToken) {
+    token = newToken;
+};
+/**
+ * Returns the current token.
+ *
+ * @internal
+ */
+export var getToken = function () { return token; };