@aws-amplify/notifications 2.0.1-api-v6-models.c1977f8.0 → 2.0.1-api-v6-models.891fe0d.0

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

@@ -1,6 +1,5 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { __read } from "tslib";
 import { ConsoleLogger } from '@aws-amplify/core';
 import { InAppMessagingAction } from '@aws-amplify/core/internals/utils';
 import isEmpty from 'lodash/isEmpty';
@@ -9,60 +8,54 @@ import { resolveConfig } from './resolveConfig';
 import { resolveCredentials } from './resolveCredentials';
 import { CATEGORY } from './constants';
 import { getInAppMessagingUserAgentString } from './userAgent';
-var DELIVERY_TYPE = 'IN_APP_MESSAGE';
-var eventNameMemo = {};
-var eventAttributesMemo = {};
-var eventMetricsMemo = {};
-export var logger = new ConsoleLogger('InAppMessaging.Pinpoint.Utils');
-export var recordAnalyticsEvent = function (event, message) {
-    var _a = resolveConfig(), appId = _a.appId, region = _a.region;
-    var id = message.id, metadata = message.metadata;
+const DELIVERY_TYPE = 'IN_APP_MESSAGE';
+let eventNameMemo = {};
+let eventAttributesMemo = {};
+let eventMetricsMemo = {};
+export const logger = new ConsoleLogger('InAppMessaging.Pinpoint.Utils');
+export const recordAnalyticsEvent = (event, message) => {
+    const { appId, region } = resolveConfig();
+    const { id, metadata } = message;
     resolveCredentials()
-        .then(function (_a) {
-        var credentials = _a.credentials, identityId = _a.identityId;
+        .then(({ credentials, identityId }) => {
         recordCore({
-            appId: appId,
+            appId,
             category: CATEGORY,
-            credentials: credentials,
+            credentials,
             event: {
                 name: event,
                 attributes: {
-                    campaign_id: id,
+                    // only include campaign_id field if we have one
+                    ...(id && { campaign_id: id }),
                     delivery_type: DELIVERY_TYPE,
-                    treatment_id: metadata === null || metadata === void 0 ? void 0 : metadata.treatmentId,
+                    treatment_id: metadata?.treatmentId,
                 },
             },
-            identityId: identityId,
-            region: region,
-            userAgentValue: getInAppMessagingUserAgentString(InAppMessagingAction.DispatchEvent),
+            identityId,
+            region,
+            userAgentValue: getInAppMessagingUserAgentString(InAppMessagingAction.NotifyMessageInteraction),
         });
     })
-        .catch(function (e) {
+        .catch(e => {
         // An error occured while fetching credentials or persisting the event to the buffer
         logger.warn('Failed to record event.', e);
     });
 };
-export var getStartOfDay = function () {
-    var now = new Date();
+export const getStartOfDay = () => {
+    const now = new Date();
     now.setHours(0, 0, 0, 0);
     return now.toISOString();
 };
-export var matchesEventType = function (_a, _b) {
-    var CampaignId = _a.CampaignId, Schedule = _a.Schedule;
-    var eventType = _b.name;
-    var _c;
-    var EventType = ((_c = Schedule === null || Schedule === void 0 ? void 0 : Schedule.EventFilter) === null || _c === void 0 ? void 0 : _c.Dimensions).EventType;
-    var memoKey = CampaignId + ":" + eventType;
+export const matchesEventType = ({ CampaignId, Schedule }, { name: eventType }) => {
+    const { EventType } = Schedule?.EventFilter?.Dimensions ?? {};
+    const memoKey = `${CampaignId}:${eventType}`;
     if (!eventNameMemo.hasOwnProperty(memoKey)) {
-        eventNameMemo[memoKey] = !!(EventType === null || EventType === void 0 ? void 0 : EventType.Values.includes(eventType));
+        eventNameMemo[memoKey] = !!EventType?.Values?.includes(eventType);
     }
     return eventNameMemo[memoKey];
 };
-export var matchesAttributes = function (_a, _b) {
-    var CampaignId = _a.CampaignId, Schedule = _a.Schedule;
-    var attributes = _b.attributes;
-    var _c;
-    var Attributes = ((_c = Schedule === null || Schedule === void 0 ? void 0 : Schedule.EventFilter) === null || _c === void 0 ? void 0 : _c.Dimensions).Attributes;
+export const matchesAttributes = ({ CampaignId, Schedule }, { attributes = {} }) => {
+    const { Attributes } = Schedule?.EventFilter?.Dimensions ?? {};
     if (isEmpty(Attributes)) {
         // if message does not have attributes defined it does not matter what attributes are on the event
         return true;
@@ -71,20 +64,16 @@ export var matchesAttributes = function (_a, _b) {
         // if message does have attributes but the event does not then it always fails the check
         return false;
     }
-    var memoKey = CampaignId + ":" + JSON.stringify(attributes);
+    const memoKey = `${CampaignId}:${JSON.stringify(attributes)}`;
     if (!eventAttributesMemo.hasOwnProperty(memoKey)) {
-        eventAttributesMemo[memoKey] = Object.entries(Attributes).every(function (_a) {
-            var _b = __read(_a, 2), key = _b[0], Values = _b[1].Values;
-            return Values.includes(attributes[key]);
-        });
+        eventAttributesMemo[memoKey] =
+            !Attributes ||
+                Object.entries(Attributes).every(([key, { Values }]) => Values?.includes(attributes[key]));
     }
     return eventAttributesMemo[memoKey];
 };
-export var matchesMetrics = function (_a, _b) {
-    var CampaignId = _a.CampaignId, Schedule = _a.Schedule;
-    var metrics = _b.metrics;
-    var _c;
-    var Metrics = ((_c = Schedule === null || Schedule === void 0 ? void 0 : Schedule.EventFilter) === null || _c === void 0 ? void 0 : _c.Dimensions).Metrics;
+export const matchesMetrics = ({ CampaignId, Schedule }, { metrics = {} }) => {
+    const { Metrics } = Schedule?.EventFilter?.Dimensions ?? {};
     if (isEmpty(Metrics)) {
         // if message does not have metrics defined it does not matter what metrics are on the event
         return true;
@@ -93,47 +82,47 @@ export var matchesMetrics = function (_a, _b) {
         // if message does have metrics but the event does not then it always fails the check
         return false;
     }
-    var memoKey = CampaignId + ":" + JSON.stringify(metrics);
+    const memoKey = `${CampaignId}:${JSON.stringify(metrics)}`;
     if (!eventMetricsMemo.hasOwnProperty(memoKey)) {
-        eventMetricsMemo[memoKey] = Object.entries(Metrics).every(function (_a) {
-            var _b = __read(_a, 2), key = _b[0], _c = _b[1], ComparisonOperator = _c.ComparisonOperator, Value = _c.Value;
-            var compare = getComparator(ComparisonOperator);
-            // if there is some unknown comparison operator, treat as a comparison failure
-            return compare ? compare(Value, metrics[key]) : false;
-        });
+        eventMetricsMemo[memoKey] =
+            !Metrics ||
+                Object.entries(Metrics).every(([key, { ComparisonOperator, Value }]) => {
+                    const compare = getComparator(ComparisonOperator);
+                    // if there is some unknown comparison operator, treat as a comparison failure
+                    return compare && !!Value ? compare(Value, metrics[key]) : false;
+                });
     }
     return eventMetricsMemo[memoKey];
 };
-export var getComparator = function (operator) {
+export const getComparator = (operator) => {
     switch (operator) {
         case 'EQUAL':
-            return function (metricsVal, eventVal) { return metricsVal === eventVal; };
+            return (metricsVal, eventVal) => metricsVal === eventVal;
         case 'GREATER_THAN':
-            return function (metricsVal, eventVal) { return metricsVal < eventVal; };
+            return (metricsVal, eventVal) => metricsVal < eventVal;
         case 'GREATER_THAN_OR_EQUAL':
-            return function (metricsVal, eventVal) { return metricsVal <= eventVal; };
+            return (metricsVal, eventVal) => metricsVal <= eventVal;
         case 'LESS_THAN':
-            return function (metricsVal, eventVal) { return metricsVal > eventVal; };
+            return (metricsVal, eventVal) => metricsVal > eventVal;
         case 'LESS_THAN_OR_EQUAL':
-            return function (metricsVal, eventVal) { return metricsVal >= eventVal; };
+            return (metricsVal, eventVal) => metricsVal >= eventVal;
         default:
-            return null;
+            return undefined;
     }
 };
-export var isBeforeEndDate = function (_a) {
-    var Schedule = _a.Schedule;
-    if (!(Schedule === null || Schedule === void 0 ? void 0 : Schedule.EndDate)) {
+export const isBeforeEndDate = ({ Schedule, }) => {
+    if (!Schedule?.EndDate) {
         return true;
     }
     return new Date() < new Date(Schedule.EndDate);
 };
-export var isQuietTime = function (message) {
-    var Schedule = message.Schedule;
-    if (!(Schedule === null || Schedule === void 0 ? void 0 : Schedule.QuietTime)) {
+export const isQuietTime = (message) => {
+    const { Schedule } = message;
+    if (!Schedule?.QuietTime) {
         return false;
     }
-    var pattern = /^[0-2]\d:[0-5]\d$/; // basic sanity check, not a fully featured HH:MM validation
-    var _a = Schedule.QuietTime, Start = _a.Start, End = _a.End;
+    const pattern = /^[0-2]\d:[0-5]\d$/; // basic sanity check, not a fully featured HH:MM validation
+    const { Start, End } = Schedule.QuietTime;
     if (!Start ||
         !End ||
         Start === End ||
@@ -141,24 +130,24 @@ export var isQuietTime = function (message) {
         !pattern.test(End)) {
         return false;
     }
-    var now = new Date();
-    var start = new Date(now);
-    var end = new Date(now);
-    var _b = __read(Start.split(':'), 2), startHours = _b[0], startMinutes = _b[1];
-    var _c = __read(End.split(':'), 2), endHours = _c[0], endMinutes = _c[1];
+    const now = new Date();
+    const start = new Date(now);
+    const end = new Date(now);
+    const [startHours, startMinutes] = Start.split(':');
+    const [endHours, endMinutes] = End.split(':');
     start.setHours(Number.parseInt(startHours, 10), Number.parseInt(startMinutes, 10), 0, 0);
     end.setHours(Number.parseInt(endHours, 10), Number.parseInt(endMinutes, 10), 0, 0);
     // if quiet time includes midnight, bump the end time to the next day
     if (start > end) {
         end.setDate(end.getDate() + 1);
     }
-    var isQuietTime = now >= start && now <= end;
+    const isQuietTime = now >= start && now <= end;
     if (isQuietTime) {
         logger.debug('message filtered due to quiet time', message);
     }
     return isQuietTime;
 };
-export var clearMemo = function () {
+export const clearMemo = () => {
     eventNameMemo = {};
     eventAttributesMemo = {};
     eventMetricsMemo = {};
@@ -172,7 +161,7 @@ export var clearMemo = function () {
 // - 1. the usage of MOBILE_FEED and OVERLAYS as values for message layouts are not leaked
 //      outside the Pinpoint provider
 // - 2. Amplify correctly handles the legacy layout values from Pinpoint after they are updated
-export var interpretLayout = function (layout) {
+export const interpretLayout = (layout) => {
     if (layout === 'MOBILE_FEED') {
         return 'MODAL';
     }
@@ -182,14 +171,12 @@ export var interpretLayout = function (layout) {
     // cast as PinpointInAppMessage['InAppMessage']['Layout'] allows `string` as a value
     return layout;
 };
-export var extractContent = function (_a) {
-    var message = _a.InAppMessage;
-    var _b, _c;
-    return ((_c = (_b = message === null || message === void 0 ? void 0 : message.Content) === null || _b === void 0 ? void 0 : _b.map(function (content) {
-        var BackgroundColor = content.BackgroundColor, BodyConfig = content.BodyConfig, HeaderConfig = content.HeaderConfig, ImageUrl = content.ImageUrl, PrimaryBtn = content.PrimaryBtn, SecondaryBtn = content.SecondaryBtn;
-        var defaultPrimaryButton = PrimaryBtn === null || PrimaryBtn === void 0 ? void 0 : PrimaryBtn.DefaultConfig;
-        var defaultSecondaryButton = SecondaryBtn === null || SecondaryBtn === void 0 ? void 0 : SecondaryBtn.DefaultConfig;
-        var extractedContent = {};
+export const extractContent = ({ InAppMessage: message, }) => {
+    return (message?.Content?.map(content => {
+        const { BackgroundColor, BodyConfig, HeaderConfig, ImageUrl, PrimaryBtn, SecondaryBtn, } = content;
+        const defaultPrimaryButton = PrimaryBtn?.DefaultConfig;
+        const defaultSecondaryButton = SecondaryBtn?.DefaultConfig;
+        const extractedContent = {};
         if (BackgroundColor) {
             extractedContent.container = {
                 style: {
@@ -199,19 +186,21 @@ export var extractContent = function (_a) {
         }
         if (HeaderConfig) {
             extractedContent.header = {
-                content: HeaderConfig.Header,
+                // Default to empty string in rare cases we don't have a Header value
+                content: HeaderConfig.Header ?? '',
                 style: {
                     color: HeaderConfig.TextColor,
-                    textAlign: HeaderConfig.Alignment.toLowerCase(),
+                    textAlign: HeaderConfig.Alignment?.toLowerCase(),
                 },
             };
         }
         if (BodyConfig) {
             extractedContent.body = {
-                content: BodyConfig.Body,
+                // Default to empty string in rare cases we don't have a Body value
+                content: BodyConfig.Body ?? '',
                 style: {
                     color: BodyConfig.TextColor,
-                    textAlign: BodyConfig.Alignment.toLowerCase(),
+                    textAlign: BodyConfig.Alignment?.toLowerCase(),
                 },
             };
         }
@@ -222,7 +211,8 @@ export var extractContent = function (_a) {
         }
         if (defaultPrimaryButton) {
             extractedContent.primaryButton = {
-                title: defaultPrimaryButton.Text,
+                // Default to empty string in rare cases we don't have a Text value
+                title: defaultPrimaryButton.Text ?? '',
                 action: defaultPrimaryButton.ButtonAction,
                 url: defaultPrimaryButton.Link,
                 style: {
@@ -234,7 +224,8 @@ export var extractContent = function (_a) {
         }
         if (defaultSecondaryButton) {
             extractedContent.secondaryButton = {
-                title: defaultSecondaryButton.Text,
+                // Default to empty string in rare cases we don't have a Text value
+                title: defaultSecondaryButton.Text ?? '',
                 action: defaultSecondaryButton.ButtonAction,
                 url: defaultSecondaryButton.Link,
                 style: {
@@ -245,14 +236,11 @@ export var extractContent = function (_a) {
             };
         }
         return extractedContent;
-    })) !== null && _c !== void 0 ? _c : []);
-};
-export var extractMetadata = function (_a) {
-    var InAppMessage = _a.InAppMessage, Priority = _a.Priority, Schedule = _a.Schedule, TreatmentId = _a.TreatmentId;
-    return ({
-        customData: InAppMessage === null || InAppMessage === void 0 ? void 0 : InAppMessage.CustomConfig,
-        endDate: Schedule === null || Schedule === void 0 ? void 0 : Schedule.EndDate,
-        priority: Priority,
-        treatmentId: TreatmentId,
-    });
+    }) ?? []);
 };
+export const extractMetadata = ({ InAppMessage, Priority, Schedule, TreatmentId, }) => ({
+    customData: InAppMessage?.CustomConfig,
+    endDate: Schedule?.EndDate,
+    priority: Priority,
+    treatmentId: TreatmentId,
+});