@aws-amplify/notifications 2.0.1-api-v6-models.9351bcf.0 → 2.0.1-api-v6-models.58f2536.0

package/lib-esm/inAppMessaging/providers/pinpoint/apis/dispatchEvent.js

@@ -1,6 +1,5 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { __awaiter, __generator } from "tslib";
 import { PINPOINT_KEY_PREFIX, STORAGE_KEY_SUFFIX, processInAppMessages, } from '../utils';
 import flatten from 'lodash/flatten';
 import { defaultStorage } from '@aws-amplify/core';
@@ -32,34 +31,19 @@ import { assertIsInitialized } from '../../../utils';
  * await dispatchEvent({ name: 'test_event' });
  * ```
  */
-export function dispatchEvent(input) {
-    return __awaiter(this, void 0, void 0, function () {
-        var key, cachedMessages, messages, flattenedMessages, error_1;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    assertIsInitialized();
-                    _a.label = 1;
-                case 1:
-                    _a.trys.push([1, 4, , 5]);
-                    key = "" + PINPOINT_KEY_PREFIX + STORAGE_KEY_SUFFIX;
-                    return [4 /*yield*/, defaultStorage.getItem(key)];
-                case 2:
-                    cachedMessages = _a.sent();
-                    return [4 /*yield*/, processInAppMessages(cachedMessages ? JSON.parse(cachedMessages) : [], input)];
-                case 3:
-                    messages = _a.sent();
-                    flattenedMessages = flatten(messages);
-                    if (flattenedMessages.length > 0) {
-                        notifyEventListeners('messageReceived', conflictHandler(flattenedMessages));
-                    }
-                    return [3 /*break*/, 5];
-                case 4:
-                    error_1 = _a.sent();
-                    assertServiceError(error_1);
-                    throw error_1;
-                case 5: return [2 /*return*/];
-            }
-        });
-    });
+export async function dispatchEvent(input) {
+    assertIsInitialized();
+    try {
+        const key = `${PINPOINT_KEY_PREFIX}${STORAGE_KEY_SUFFIX}`;
+        const cachedMessages = await defaultStorage.getItem(key);
+        const messages = await processInAppMessages(cachedMessages ? JSON.parse(cachedMessages) : [], input);
+        const flattenedMessages = flatten(messages);
+        if (flattenedMessages.length > 0) {
+            notifyEventListeners('messageReceived', conflictHandler(flattenedMessages));
+        }
+    }
+    catch (error) {
+        assertServiceError(error);
+        throw error;
+    }
 }

package/lib-esm/inAppMessaging/providers/pinpoint/apis/identifyUser.d.ts

@@ -1,3 +1,4 @@
+import { IdentifyUserInput } 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
@@ -47,4 +48,4 @@
  *     },
  * });
  */
-export declare const identifyUser: ({ userId, userProfile, options, }: import("../../../types").InAppMessagingIdentifyUserInput<import("@aws-amplify/core/lib-esm/providers/pinpoint").PinpointServiceOptions>) => Promise<void>;
+export declare const identifyUser: ({ userId, userProfile, options, }: IdentifyUserInput) => Promise<void>;

package/lib-esm/inAppMessaging/providers/pinpoint/apis/identifyUser.js

@@ -1,6 +1,5 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { __awaiter, __generator } from "tslib";
 import { InAppMessagingAction } from '@aws-amplify/core/internals/utils';
 import { updateEndpoint, } from '@aws-amplify/core/internals/providers/pinpoint';
 import { CATEGORY, CHANNEL_TYPE, getInAppMessagingUserAgentString, resolveConfig, resolveCredentials, } from '../utils';
@@ -54,35 +53,23 @@ import { assertIsInitialized } from '../../../utils';
  *     },
  * });
  */
-export var identifyUser = function (_a) {
-    var userId = _a.userId, userProfile = _a.userProfile, options = _a.options;
-    return __awaiter(void 0, void 0, void 0, function () {
-        var _b, credentials, identityId, _c, appId, region, _d, address, optOut, userAttributes;
-        return __generator(this, function (_e) {
-            switch (_e.label) {
-                case 0:
-                    assertIsInitialized();
-                    return [4 /*yield*/, resolveCredentials()];
-                case 1:
-                    _b = _e.sent(), credentials = _b.credentials, identityId = _b.identityId;
-                    _c = resolveConfig(), appId = _c.appId, region = _c.region;
-                    _d = options !== null && options !== void 0 ? options : {}, address = _d.address, optOut = _d.optOut, userAttributes = _d.userAttributes;
-                    updateEndpoint({
-                        address: address,
-                        channelType: CHANNEL_TYPE,
-                        optOut: optOut,
-                        appId: appId,
-                        category: CATEGORY,
-                        credentials: credentials,
-                        identityId: identityId,
-                        region: region,
-                        userAttributes: userAttributes,
-                        userId: userId,
-                        userProfile: userProfile,
-                        userAgentValue: getInAppMessagingUserAgentString(InAppMessagingAction.IdentifyUser),
-                    });
-                    return [2 /*return*/];
-            }
-        });
+export const identifyUser = async ({ userId, userProfile, options, }) => {
+    assertIsInitialized();
+    const { credentials, identityId } = await resolveCredentials();
+    const { appId, region } = resolveConfig();
+    const { address, optOut, userAttributes } = options ?? {};
+    updateEndpoint({
+        address,
+        channelType: CHANNEL_TYPE,
+        optOut,
+        appId,
+        category: CATEGORY,
+        credentials,
+        identityId,
+        region,
+        userAttributes,
+        userId,
+        userProfile,
+        userAgentValue: getInAppMessagingUserAgentString(InAppMessagingAction.IdentifyUser),
     });
 };

package/lib-esm/inAppMessaging/providers/pinpoint/apis/index.d.ts

@@ -8,3 +8,4 @@ export { onMessageDismissed } from './onMessageDismissed';
 export { onMessageDisplayed } from './onMessageDisplayed';
 export { onMessageActionTaken } from './onMessageActionTaken';
 export { notifyMessageInteraction } from './notifyMessageInteraction';
+export { clearMessages } from './clearMessages';

package/lib-esm/inAppMessaging/providers/pinpoint/apis/index.js

@@ -10,3 +10,4 @@ export { onMessageDismissed } from './onMessageDismissed';
 export { onMessageDisplayed } from './onMessageDisplayed';
 export { onMessageActionTaken } from './onMessageActionTaken';
 export { notifyMessageInteraction } from './notifyMessageInteraction';
+export { clearMessages } from './clearMessages';

package/lib-esm/inAppMessaging/providers/pinpoint/apis/initializeInAppMessaging.js

@@ -26,23 +26,22 @@ export function initializeInAppMessaging() {
     // register with the session listener
     sessionListener.addStateChangeListener(sessionStateChangeHandler, true);
     // wire up default Pinpoint message event handling
-    addEventListener('messageDisplayed', function (message) {
+    addEventListener('messageDisplayed', (message) => {
         recordAnalyticsEvent(PinpointMessageEvent.MESSAGE_DISPLAYED, message);
         incrementMessageCounts(message.id);
     });
-    addEventListener('messageDismissed', function (message) {
+    addEventListener('messageDismissed', (message) => {
         recordAnalyticsEvent(PinpointMessageEvent.MESSAGE_DISMISSED, message);
     });
-    addEventListener('messageActionTaken', function (message) {
+    addEventListener('messageActionTaken', (message) => {
         recordAnalyticsEvent(PinpointMessageEvent.MESSAGE_ACTION_TAKEN, message);
     });
     // listen to analytics hub events
     Hub.listen('analytics', analyticsListener);
     initialize();
 }
-function analyticsListener(_a) {
-    var payload = _a.payload;
-    var event = payload.event, data = payload.data;
+function analyticsListener({ payload, }) {
+    const { event, data } = payload;
     switch (event) {
         case 'record': {
             dispatchEvent(data);

package/lib-esm/inAppMessaging/providers/pinpoint/apis/notifyMessageInteraction.js

@@ -16,8 +16,7 @@ import { assertIsInitialized } from '../../../utils';
  * });
  * ```
  */
-export function notifyMessageInteraction(_a) {
-    var type = _a.type, message = _a.message;
+export function notifyMessageInteraction({ type, message, }) {
     assertIsInitialized();
     notifyEventListeners(type, message);
 }

package/lib-esm/inAppMessaging/providers/pinpoint/apis/setConflictHandler.js

@@ -1,7 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import { assertIsInitialized } from '../../../utils';
-export var conflictHandler = defaultConflictHandler;
+export let conflictHandler = defaultConflictHandler;
 /**
  * Set a conflict handler that will be used to resolve conflicts that may emerge
  * when matching events with synced messages.
@@ -38,10 +38,9 @@ export function setConflictHandler(input) {
 function defaultConflictHandler(messages) {
     // default behavior is to return the message closest to expiry
     // this function assumes that messages processed by providers already filters out expired messages
-    var sorted = messages.sort(function (a, b) {
-        var _a, _b;
-        var endDateA = (_a = a.metadata) === null || _a === void 0 ? void 0 : _a.endDate;
-        var endDateB = (_b = b.metadata) === null || _b === void 0 ? void 0 : _b.endDate;
+    const sorted = messages.sort((a, b) => {
+        const endDateA = a.metadata?.endDate;
+        const endDateB = b.metadata?.endDate;
         // if both message end dates are falsy or have the same date string, treat them as equal
         if (endDateA === endDateB) {
             return 0;

package/lib-esm/inAppMessaging/providers/pinpoint/apis/syncMessages.js

@@ -1,6 +1,5 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { __awaiter, __generator } from "tslib";
 import { InAppMessagingAction } from '@aws-amplify/core/internals/utils';
 import { resolveEndpointId } from '@aws-amplify/core/internals/providers/pinpoint';
 import { defaultStorage } from '@aws-amplify/core';
@@ -23,74 +22,44 @@ import { assertIsInitialized } from '../../../utils';
  *
  * ```
  */
-export function syncMessages() {
-    return __awaiter(this, void 0, void 0, function () {
-        var messages, key, error_1;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    assertIsInitialized();
-                    return [4 /*yield*/, fetchInAppMessages()];
-                case 1:
-                    messages = _a.sent();
-                    if (!messages || messages.length === 0) {
-                        return [2 /*return*/];
-                    }
-                    _a.label = 2;
-                case 2:
-                    _a.trys.push([2, 4, , 5]);
-                    key = "" + PINPOINT_KEY_PREFIX + STORAGE_KEY_SUFFIX;
-                    return [4 /*yield*/, defaultStorage.setItem(key, JSON.stringify(messages))];
-                case 3:
-                    _a.sent();
-                    return [3 /*break*/, 5];
-                case 4:
-                    error_1 = _a.sent();
-                    assertServiceError(error_1);
-                    throw error_1;
-                case 5: return [2 /*return*/];
-            }
-        });
-    });
+export async function syncMessages() {
+    assertIsInitialized();
+    const messages = await fetchInAppMessages();
+    if (!messages || messages.length === 0) {
+        return;
+    }
+    try {
+        const key = `${PINPOINT_KEY_PREFIX}${STORAGE_KEY_SUFFIX}`;
+        await defaultStorage.setItem(key, JSON.stringify(messages));
+    }
+    catch (error) {
+        assertServiceError(error);
+        throw error;
+    }
 }
-function fetchInAppMessages() {
-    var _a;
-    return __awaiter(this, void 0, void 0, function () {
-        var _b, credentials, identityId, _c, appId, region, endpointId, input, response, messages, error_2;
-        return __generator(this, function (_d) {
-            switch (_d.label) {
-                case 0:
-                    _d.trys.push([0, 4, , 5]);
-                    return [4 /*yield*/, resolveCredentials()];
-                case 1:
-                    _b = _d.sent(), credentials = _b.credentials, identityId = _b.identityId;
-                    _c = resolveConfig(), appId = _c.appId, region = _c.region;
-                    return [4 /*yield*/, resolveEndpointId({
-                            appId: appId,
-                            category: CATEGORY,
-                            channelType: CHANNEL_TYPE,
-                            credentials: credentials,
-                            identityId: identityId,
-                            region: region,
-                            userAgentValue: getInAppMessagingUserAgentString(InAppMessagingAction.SyncMessages),
-                        })];
-                case 2:
-                    endpointId = _d.sent();
-                    input = {
-                        ApplicationId: appId,
-                        EndpointId: endpointId,
-                    };
-                    return [4 /*yield*/, getInAppMessages({ credentials: credentials, region: region }, input)];
-                case 3:
-                    response = _d.sent();
-                    messages = ((_a = response.InAppMessagesResponse) !== null && _a !== void 0 ? _a : {}).InAppMessageCampaigns;
-                    return [2 /*return*/, messages];
-                case 4:
-                    error_2 = _d.sent();
-                    assertServiceError(error_2);
-                    throw error_2;
-                case 5: return [2 /*return*/];
-            }
+async function fetchInAppMessages() {
+    try {
+        const { credentials, identityId } = await resolveCredentials();
+        const { appId, region } = resolveConfig();
+        const endpointId = await resolveEndpointId({
+            appId,
+            category: CATEGORY,
+            channelType: CHANNEL_TYPE,
+            credentials,
+            identityId,
+            region,
+            userAgentValue: getInAppMessagingUserAgentString(InAppMessagingAction.SyncMessages),
         });
-    });
+        const input = {
+            ApplicationId: appId,
+            EndpointId: endpointId,
+        };
+        const response = await getInAppMessages({ credentials, region }, input);
+        const { InAppMessageCampaigns: messages } = response.InAppMessagesResponse ?? {};
+        return messages;
+    }
+    catch (error) {
+        assertServiceError(error);
+        throw error;
+    }
 }

package/lib-esm/inAppMessaging/providers/pinpoint/index.d.ts

@@ -1,2 +1,2 @@
-export { identifyUser, syncMessages, dispatchEvent, setConflictHandler, initializeInAppMessaging, onMessageReceived, onMessageDisplayed, onMessageDismissed, onMessageActionTaken, notifyMessageInteraction, } from './apis';
+export { identifyUser, syncMessages, dispatchEvent, setConflictHandler, initializeInAppMessaging, onMessageReceived, onMessageDisplayed, onMessageDismissed, onMessageActionTaken, notifyMessageInteraction, clearMessages, } from './apis';
 export { IdentifyUserInput, DispatchEventInput, SetConflictHandlerInput, OnMessageActionTakenInput, OnMessageDismissedInput, OnMessageDisplayedInput, OnMessageReceivedInput, NotifyMessageInteractionInput, OnMessageReceivedOutput, OnMessageActionTakenOutput, OnMessageDismissedOutput, OnMessageDisplayedOutput, } from './types';

package/lib-esm/inAppMessaging/providers/pinpoint/index.js

@@ -1,3 +1,3 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-export { identifyUser, syncMessages, dispatchEvent, setConflictHandler, initializeInAppMessaging, onMessageReceived, onMessageDisplayed, onMessageDismissed, onMessageActionTaken, notifyMessageInteraction, } from './apis';
+export { identifyUser, syncMessages, dispatchEvent, setConflictHandler, initializeInAppMessaging, onMessageReceived, onMessageDisplayed, onMessageDismissed, onMessageActionTaken, notifyMessageInteraction, clearMessages, } from './apis';

package/lib-esm/inAppMessaging/providers/pinpoint/types/inputs.d.ts

@@ -3,35 +3,35 @@ import { InAppMessage, InAppMessageInteractionEvent, InAppMessagingEvent, InAppM
 /**
  * Input type for Pinpoint identifyUser API.
  */
-export declare type IdentifyUserInput = InAppMessagingIdentifyUserInput<IdentifyUserOptions>;
+export type IdentifyUserInput = InAppMessagingIdentifyUserInput<IdentifyUserOptions>;
 /**
  * Input type for Pinpoint dispatchEvent API.
  */
-export declare type DispatchEventInput = InAppMessagingEvent;
+export type DispatchEventInput = InAppMessagingEvent;
 /**
  * Input type for Pinpoint SetConflictHandler API.
  */
-export declare type SetConflictHandlerInput = InAppMessageConflictHandler;
+export type SetConflictHandlerInput = InAppMessageConflictHandler;
 /**
  * Input type for OnMessageReceived API.
  */
-export declare type OnMessageReceivedInput = OnMessageInteractionEventHandler;
+export type OnMessageReceivedInput = OnMessageInteractionEventHandler;
 /**
  * Input type for OnMessageDisplayed API.
  */
-export declare type OnMessageDisplayedInput = OnMessageInteractionEventHandler;
+export type OnMessageDisplayedInput = OnMessageInteractionEventHandler;
 /**
  * Input type for OnMessageDismissed API.
  */
-export declare type OnMessageDismissedInput = OnMessageInteractionEventHandler;
+export type OnMessageDismissedInput = OnMessageInteractionEventHandler;
 /**
  * Input type for OnMessageActionTaken API.
  */
-export declare type OnMessageActionTakenInput = OnMessageInteractionEventHandler;
+export type OnMessageActionTakenInput = OnMessageInteractionEventHandler;
 /**
  * Input type for NotifyMessageInteraction API.
  */
-export declare type NotifyMessageInteractionInput = {
+export type NotifyMessageInteractionInput = {
     message: InAppMessage;
     type: InAppMessageInteractionEvent;
 };

package/lib-esm/inAppMessaging/providers/pinpoint/types/inputs.js

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

package/lib-esm/inAppMessaging/providers/pinpoint/types/options.d.ts

@@ -2,4 +2,4 @@ import { PinpointServiceOptions } from '@aws-amplify/core/internals/providers/pi
 /**
  * Options specific to Pinpoint identityUser.
  */
-export declare type IdentifyUserOptions = PinpointServiceOptions;
+export type IdentifyUserOptions = PinpointServiceOptions;

package/lib-esm/inAppMessaging/providers/pinpoint/types/options.js

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

package/lib-esm/inAppMessaging/providers/pinpoint/types/outputs.d.ts

@@ -2,16 +2,16 @@ import { EventListenerRemover } from '../../../../eventListeners';
 /**
  * Output type for OnMessageReceived API.
  */
-export declare type OnMessageReceivedOutput = EventListenerRemover;
+export type OnMessageReceivedOutput = EventListenerRemover;
 /**
  * Output type for OnMessageDisplayed API.
  */
-export declare type OnMessageDisplayedOutput = EventListenerRemover;
+export type OnMessageDisplayedOutput = EventListenerRemover;
 /**
  * Output type for OnMessageDismissed API.
  */
-export declare type OnMessageDismissedOutput = EventListenerRemover;
+export type OnMessageDismissedOutput = EventListenerRemover;
 /**
  * Output type for OnMessageActionTaken API.
  */
-export declare type OnMessageActionTakenOutput = EventListenerRemover;
+export type OnMessageActionTakenOutput = EventListenerRemover;

package/lib-esm/inAppMessaging/providers/pinpoint/types/outputs.js

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

package/lib-esm/inAppMessaging/providers/pinpoint/types/types.d.ts

@@ -1,19 +1,19 @@
 import { InAppMessage } from '../../../types';
-export declare type InAppMessageCountMap = Record<string, number>;
-export declare type DailyInAppMessageCounter = {
+export type InAppMessageCountMap = Record<string, number>;
+export type DailyInAppMessageCounter = {
     count: number;
     lastCountTimestamp: string;
 };
-export declare type InAppMessageCounts = {
+export type InAppMessageCounts = {
     sessionCount: number;
     dailyCount: number;
     totalCount: number;
 };
-export declare type MetricsComparator = (metricsVal: number, eventVal: number) => boolean;
+export type MetricsComparator = (metricsVal: number, eventVal: number) => boolean;
 export declare enum PinpointMessageEvent {
     MESSAGE_DISPLAYED = "_inapp.message_displayed",
     MESSAGE_DISMISSED = "_inapp.message_dismissed",
     MESSAGE_ACTION_TAKEN = "_inapp.message_clicked"
 }
-export declare type InAppMessageConflictHandler = (messages: InAppMessage[]) => InAppMessage;
-export declare type OnMessageInteractionEventHandler = (message: InAppMessage) => void;
+export type InAppMessageConflictHandler = (messages: InAppMessage[]) => InAppMessage;
+export type OnMessageInteractionEventHandler = (message: InAppMessage) => void;

package/lib-esm/inAppMessaging/providers/pinpoint/utils/constants.js

@@ -1,6 +1,6 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-export var PINPOINT_KEY_PREFIX = 'Pinpoint';
-export var STORAGE_KEY_SUFFIX = '_inAppMessages';
-export var CATEGORY = 'InAppMessaging';
-export var CHANNEL_TYPE = 'IN_APP';
+export const PINPOINT_KEY_PREFIX = 'Pinpoint';
+export const STORAGE_KEY_SUFFIX = '_inAppMessages';
+export const CATEGORY = 'InAppMessaging';
+export const CHANNEL_TYPE = 'IN_APP';

package/lib-esm/inAppMessaging/providers/pinpoint/utils/helpers.d.ts

@@ -5,13 +5,13 @@ import { MetricsComparator, PinpointMessageEvent } from '../types';
 export declare const logger: ConsoleLogger;
 export declare const recordAnalyticsEvent: (event: PinpointMessageEvent, message: InAppMessage) => void;
 export declare const getStartOfDay: () => string;
-export declare const matchesEventType: ({ CampaignId, Schedule }: PinpointInAppMessage, { name: eventType }: InAppMessagingEvent) => any;
+export declare const matchesEventType: ({ CampaignId, Schedule }: PinpointInAppMessage, { name: eventType }: InAppMessagingEvent) => boolean;
 export declare const matchesAttributes: ({ CampaignId, Schedule }: PinpointInAppMessage, { attributes }: InAppMessagingEvent) => boolean;
 export declare const matchesMetrics: ({ CampaignId, Schedule }: PinpointInAppMessage, { metrics }: InAppMessagingEvent) => boolean;
-export declare const getComparator: (operator: string) => MetricsComparator;
+export declare const getComparator: (operator?: string) => MetricsComparator | undefined;
 export declare const isBeforeEndDate: ({ Schedule, }: PinpointInAppMessage) => boolean;
 export declare const isQuietTime: (message: PinpointInAppMessage) => boolean;
 export declare const clearMemo: () => void;
-export declare const interpretLayout: (layout: string) => InAppMessageLayout;
+export declare const interpretLayout: (layout: NonNullable<PinpointInAppMessage['InAppMessage']>['Layout']) => InAppMessageLayout;
 export declare const extractContent: ({ InAppMessage: message, }: PinpointInAppMessage) => InAppMessageContent[];
 export declare const extractMetadata: ({ InAppMessage, Priority, Schedule, TreatmentId, }: PinpointInAppMessage) => any;