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

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

@@ -0,0 +1,264 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractMetadata = exports.extractContent = exports.interpretLayout = exports.clearMemo = exports.isQuietTime = exports.isBeforeEndDate = exports.getComparator = exports.matchesMetrics = exports.matchesAttributes = exports.matchesEventType = exports.getStartOfDay = exports.recordAnalyticsEvent = exports.logger = void 0;
+const core_1 = require("@aws-amplify/core");
+const utils_1 = require("@aws-amplify/core/internals/utils");
+const isEmpty_1 = __importDefault(require("lodash/isEmpty"));
+const pinpoint_1 = require("@aws-amplify/core/internals/providers/pinpoint");
+const resolveConfig_1 = require("./resolveConfig");
+const resolveCredentials_1 = require("./resolveCredentials");
+const constants_1 = require("./constants");
+const userAgent_1 = require("./userAgent");
+const DELIVERY_TYPE = 'IN_APP_MESSAGE';
+let eventNameMemo = {};
+let eventAttributesMemo = {};
+let eventMetricsMemo = {};
+exports.logger = new core_1.ConsoleLogger('InAppMessaging.Pinpoint.Utils');
+const recordAnalyticsEvent = (event, message) => {
+    const { appId, region } = (0, resolveConfig_1.resolveConfig)();
+    const { id, metadata } = message;
+    (0, resolveCredentials_1.resolveCredentials)()
+        .then(({ credentials, identityId }) => {
+        (0, pinpoint_1.record)({
+            appId,
+            category: constants_1.CATEGORY,
+            credentials,
+            event: {
+                name: event,
+                attributes: {
+                    // only include campaign_id field if we have one
+                    ...(id && { campaign_id: id }),
+                    delivery_type: DELIVERY_TYPE,
+                    treatment_id: metadata?.treatmentId,
+                },
+            },
+            identityId,
+            region,
+            userAgentValue: (0, userAgent_1.getInAppMessagingUserAgentString)(utils_1.InAppMessagingAction.NotifyMessageInteraction),
+        });
+    })
+        .catch(e => {
+        // An error occured while fetching credentials or persisting the event to the buffer
+        exports.logger.warn('Failed to record event.', e);
+    });
+};
+exports.recordAnalyticsEvent = recordAnalyticsEvent;
+const getStartOfDay = () => {
+    const now = new Date();
+    now.setHours(0, 0, 0, 0);
+    return now.toISOString();
+};
+exports.getStartOfDay = getStartOfDay;
+const matchesEventType = ({ CampaignId, Schedule }, { name: eventType }) => {
+    const { EventType } = Schedule?.EventFilter?.Dimensions ?? {};
+    const memoKey = `${CampaignId}:${eventType}`;
+    if (!eventNameMemo.hasOwnProperty(memoKey)) {
+        eventNameMemo[memoKey] = !!EventType?.Values?.includes(eventType);
+    }
+    return eventNameMemo[memoKey];
+};
+exports.matchesEventType = matchesEventType;
+const matchesAttributes = ({ CampaignId, Schedule }, { attributes = {} }) => {
+    const { Attributes } = Schedule?.EventFilter?.Dimensions ?? {};
+    if ((0, isEmpty_1.default)(Attributes)) {
+        // if message does not have attributes defined it does not matter what attributes are on the event
+        return true;
+    }
+    if ((0, isEmpty_1.default)(attributes)) {
+        // if message does have attributes but the event does not then it always fails the check
+        return false;
+    }
+    const memoKey = `${CampaignId}:${JSON.stringify(attributes)}`;
+    if (!eventAttributesMemo.hasOwnProperty(memoKey)) {
+        eventAttributesMemo[memoKey] =
+            !Attributes ||
+                Object.entries(Attributes).every(([key, { Values }]) => Values?.includes(attributes[key]));
+    }
+    return eventAttributesMemo[memoKey];
+};
+exports.matchesAttributes = matchesAttributes;
+const matchesMetrics = ({ CampaignId, Schedule }, { metrics = {} }) => {
+    const { Metrics } = Schedule?.EventFilter?.Dimensions ?? {};
+    if ((0, isEmpty_1.default)(Metrics)) {
+        // if message does not have metrics defined it does not matter what metrics are on the event
+        return true;
+    }
+    if ((0, isEmpty_1.default)(metrics)) {
+        // if message does have metrics but the event does not then it always fails the check
+        return false;
+    }
+    const memoKey = `${CampaignId}:${JSON.stringify(metrics)}`;
+    if (!eventMetricsMemo.hasOwnProperty(memoKey)) {
+        eventMetricsMemo[memoKey] =
+            !Metrics ||
+                Object.entries(Metrics).every(([key, { ComparisonOperator, Value }]) => {
+                    const compare = (0, exports.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];
+};
+exports.matchesMetrics = matchesMetrics;
+const getComparator = (operator) => {
+    switch (operator) {
+        case 'EQUAL':
+            return (metricsVal, eventVal) => metricsVal === eventVal;
+        case 'GREATER_THAN':
+            return (metricsVal, eventVal) => metricsVal < eventVal;
+        case 'GREATER_THAN_OR_EQUAL':
+            return (metricsVal, eventVal) => metricsVal <= eventVal;
+        case 'LESS_THAN':
+            return (metricsVal, eventVal) => metricsVal > eventVal;
+        case 'LESS_THAN_OR_EQUAL':
+            return (metricsVal, eventVal) => metricsVal >= eventVal;
+        default:
+            return undefined;
+    }
+};
+exports.getComparator = getComparator;
+const isBeforeEndDate = ({ Schedule, }) => {
+    if (!Schedule?.EndDate) {
+        return true;
+    }
+    return new Date() < new Date(Schedule.EndDate);
+};
+exports.isBeforeEndDate = isBeforeEndDate;
+const isQuietTime = (message) => {
+    const { Schedule } = message;
+    if (!Schedule?.QuietTime) {
+        return false;
+    }
+    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 ||
+        !pattern.test(Start) ||
+        !pattern.test(End)) {
+        return false;
+    }
+    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);
+    }
+    const isQuietTime = now >= start && now <= end;
+    if (isQuietTime) {
+        exports.logger.debug('message filtered due to quiet time', message);
+    }
+    return isQuietTime;
+};
+exports.isQuietTime = isQuietTime;
+const clearMemo = () => {
+    eventNameMemo = {};
+    eventAttributesMemo = {};
+    eventMetricsMemo = {};
+};
+exports.clearMemo = clearMemo;
+// in the pinpoint console when a message is created with a Modal or Full Screen layout,
+// it is assigned a layout value of MOBILE_FEED or OVERLAYS respectively in the message payload.
+// In the future, Pinpoint will be updating the layout values in the aforementioned scenario
+// to MODAL and FULL_SCREEN.
+//
+// This utility acts as a safeguard to ensure that:
+// - 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
+const interpretLayout = (layout) => {
+    if (layout === 'MOBILE_FEED') {
+        return 'MODAL';
+    }
+    if (layout === 'OVERLAYS') {
+        return 'FULL_SCREEN';
+    }
+    // cast as PinpointInAppMessage['InAppMessage']['Layout'] allows `string` as a value
+    return layout;
+};
+exports.interpretLayout = interpretLayout;
+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: {
+                    backgroundColor: BackgroundColor,
+                },
+            };
+        }
+        if (HeaderConfig) {
+            extractedContent.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(),
+                },
+            };
+        }
+        if (BodyConfig) {
+            extractedContent.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(),
+                },
+            };
+        }
+        if (ImageUrl) {
+            extractedContent.image = {
+                src: ImageUrl,
+            };
+        }
+        if (defaultPrimaryButton) {
+            extractedContent.primaryButton = {
+                // Default to empty string in rare cases we don't have a Text value
+                title: defaultPrimaryButton.Text ?? '',
+                action: defaultPrimaryButton.ButtonAction,
+                url: defaultPrimaryButton.Link,
+                style: {
+                    backgroundColor: defaultPrimaryButton.BackgroundColor,
+                    borderRadius: defaultPrimaryButton.BorderRadius,
+                    color: defaultPrimaryButton.TextColor,
+                },
+            };
+        }
+        if (defaultSecondaryButton) {
+            extractedContent.secondaryButton = {
+                // Default to empty string in rare cases we don't have a Text value
+                title: defaultSecondaryButton.Text ?? '',
+                action: defaultSecondaryButton.ButtonAction,
+                url: defaultSecondaryButton.Link,
+                style: {
+                    backgroundColor: defaultSecondaryButton.BackgroundColor,
+                    borderRadius: defaultSecondaryButton.BorderRadius,
+                    color: defaultSecondaryButton.TextColor,
+                },
+            };
+        }
+        return extractedContent;
+    }) ?? []);
+};
+exports.extractContent = extractContent;
+const extractMetadata = ({ InAppMessage, Priority, Schedule, TreatmentId, }) => ({
+    customData: InAppMessage?.CustomConfig,
+    endDate: Schedule?.EndDate,
+    priority: Priority,
+    treatmentId: TreatmentId,
+});
+exports.extractMetadata = extractMetadata;

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

@@ -0,0 +1,5 @@
+export { resolveConfig } from './resolveConfig';
+export { resolveCredentials } from './resolveCredentials';
+export { getInAppMessagingUserAgentString } from './userAgent';
+export { PINPOINT_KEY_PREFIX, CATEGORY, CHANNEL_TYPE, STORAGE_KEY_SUFFIX, } from './constants';
+export { processInAppMessages, sessionStateChangeHandler, incrementMessageCounts, } from './messageProcessingHelpers';

package/lib/inAppMessaging/providers/pinpoint/utils/index.js

@@ -0,0 +1,20 @@
+"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.incrementMessageCounts = exports.sessionStateChangeHandler = exports.processInAppMessages = exports.STORAGE_KEY_SUFFIX = exports.CHANNEL_TYPE = exports.CATEGORY = exports.PINPOINT_KEY_PREFIX = exports.getInAppMessagingUserAgentString = exports.resolveCredentials = exports.resolveConfig = void 0;
+var resolveConfig_1 = require("./resolveConfig");
+Object.defineProperty(exports, "resolveConfig", { enumerable: true, get: function () { return resolveConfig_1.resolveConfig; } });
+var resolveCredentials_1 = require("./resolveCredentials");
+Object.defineProperty(exports, "resolveCredentials", { enumerable: true, get: function () { return resolveCredentials_1.resolveCredentials; } });
+var userAgent_1 = require("./userAgent");
+Object.defineProperty(exports, "getInAppMessagingUserAgentString", { enumerable: true, get: function () { return userAgent_1.getInAppMessagingUserAgentString; } });
+var constants_1 = require("./constants");
+Object.defineProperty(exports, "PINPOINT_KEY_PREFIX", { enumerable: true, get: function () { return constants_1.PINPOINT_KEY_PREFIX; } });
+Object.defineProperty(exports, "CATEGORY", { enumerable: true, get: function () { return constants_1.CATEGORY; } });
+Object.defineProperty(exports, "CHANNEL_TYPE", { enumerable: true, get: function () { return constants_1.CHANNEL_TYPE; } });
+Object.defineProperty(exports, "STORAGE_KEY_SUFFIX", { enumerable: true, get: function () { return constants_1.STORAGE_KEY_SUFFIX; } });
+var messageProcessingHelpers_1 = require("./messageProcessingHelpers");
+Object.defineProperty(exports, "processInAppMessages", { enumerable: true, get: function () { return messageProcessingHelpers_1.processInAppMessages; } });
+Object.defineProperty(exports, "sessionStateChangeHandler", { enumerable: true, get: function () { return messageProcessingHelpers_1.sessionStateChangeHandler; } });
+Object.defineProperty(exports, "incrementMessageCounts", { enumerable: true, get: function () { return messageProcessingHelpers_1.incrementMessageCounts; } });

package/lib/inAppMessaging/providers/pinpoint/utils/messageProcessingHelpers.d.ts

@@ -0,0 +1,6 @@
+import { InAppMessage, InAppMessagingEvent } from '../../../types';
+import type { InAppMessageCampaign as PinpointInAppMessage } from '@aws-amplify/core/internals/aws-clients/pinpoint';
+import { SessionState } from '@aws-amplify/core/internals/utils';
+export declare function processInAppMessages(messages: PinpointInAppMessage[], event: InAppMessagingEvent): Promise<InAppMessage[]>;
+export declare function sessionStateChangeHandler(state: SessionState): void;
+export declare function incrementMessageCounts(messageId: string): Promise<void>;

package/lib/inAppMessaging/providers/pinpoint/utils/messageProcessingHelpers.js

@@ -0,0 +1,169 @@
+"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.incrementMessageCounts = exports.sessionStateChangeHandler = exports.processInAppMessages = void 0;
+const helpers_1 = require("./helpers");
+const core_1 = require("@aws-amplify/core");
+const MESSAGE_DAILY_COUNT_KEY = 'pinpointProvider_inAppMessages_dailyCount';
+const MESSAGE_TOTAL_COUNT_KEY = 'pinpointProvider_inAppMessages_totalCount';
+const logger = new core_1.ConsoleLogger('InAppMessaging.processInAppMessages');
+let sessionMessageCountMap = {};
+async function processInAppMessages(messages, event) {
+    let highestPrioritySeen;
+    let acc = [];
+    for (let index = 0; index < messages.length; index++) {
+        const message = messages[index];
+        const messageQualifies = (0, helpers_1.matchesEventType)(message, event) &&
+            (0, helpers_1.matchesAttributes)(message, event) &&
+            (0, helpers_1.matchesMetrics)(message, event) &&
+            (0, helpers_1.isBeforeEndDate)(message) &&
+            (await isBelowCap(message));
+        // filter all qualifying messages returning only those that are of (relative) highest priority
+        if (messageQualifies) {
+            // have not yet encountered message with priority
+            if (!highestPrioritySeen) {
+                // this message has priority, so reset the accumulator with this message only
+                if (message.Priority) {
+                    highestPrioritySeen = message.Priority;
+                    acc = [message];
+                }
+                else {
+                    // this message also has no priority, so just add this message to accumulator
+                    acc.push(message);
+                }
+                // have previously encountered message with priority, so only messages with priority matter now
+            }
+            else if (message.Priority) {
+                // this message has higher priority (lower number), so reset the accumulator with this message only
+                if (message.Priority < highestPrioritySeen) {
+                    highestPrioritySeen = message.Priority;
+                    acc = [message];
+                    // this message has the same priority, so just add this message to accumulator
+                }
+                else if (message.Priority === highestPrioritySeen) {
+                    acc.push(message);
+                }
+            }
+        }
+    }
+    return normalizeMessages(acc);
+}
+exports.processInAppMessages = processInAppMessages;
+function sessionStateChangeHandler(state) {
+    if (state === 'started') {
+        // reset all session counts
+        sessionMessageCountMap = {};
+    }
+}
+exports.sessionStateChangeHandler = sessionStateChangeHandler;
+async function incrementMessageCounts(messageId) {
+    const { sessionCount, dailyCount, totalCount } = await getMessageCounts(messageId);
+    setSessionCount(messageId, sessionCount + 1);
+    setDailyCount(dailyCount + 1);
+    await setTotalCount(messageId, totalCount + 1);
+}
+exports.incrementMessageCounts = incrementMessageCounts;
+function normalizeMessages(messages) {
+    return messages.map(message => {
+        const { CampaignId, InAppMessage } = message;
+        return {
+            // Default to empty string in rare cases we don't have a campaignId
+            id: CampaignId ?? '',
+            content: (0, helpers_1.extractContent)(message),
+            // Default to TOP_BANNER layout in rare cases we don't have a Layout
+            layout: InAppMessage?.Layout
+                ? (0, helpers_1.interpretLayout)(InAppMessage.Layout)
+                : 'TOP_BANNER',
+            metadata: (0, helpers_1.extractMetadata)(message),
+        };
+    });
+}
+async function isBelowCap({ CampaignId, SessionCap, DailyCap, TotalCap, }) {
+    const { sessionCount, dailyCount, totalCount } = await getMessageCounts(CampaignId);
+    return ((!SessionCap || sessionCount < SessionCap) &&
+        (!DailyCap || dailyCount < DailyCap) &&
+        (!TotalCap || totalCount < TotalCap));
+}
+async function getMessageCounts(messageId) {
+    let messageCounts = {
+        sessionCount: 0,
+        dailyCount: 0,
+        totalCount: 0,
+    };
+    try {
+        // only return true counts if there is a messageId else default to 0
+        if (messageId)
+            messageCounts = {
+                sessionCount: getSessionCount(messageId),
+                dailyCount: await getDailyCount(),
+                totalCount: await getTotalCount(messageId),
+            };
+        return messageCounts;
+    }
+    catch (err) {
+        logger.error('Failed to get message counts from storage', err);
+        // If there are no cached counts or there is an error,
+        // we default to 0 allowing all the messages to be eligible
+        return messageCounts;
+    }
+}
+function getSessionCount(messageId) {
+    return sessionMessageCountMap[messageId] ?? 0;
+}
+function setSessionCount(messageId, count) {
+    sessionMessageCountMap[messageId] = count;
+}
+function setDailyCount(count) {
+    const dailyCount = {
+        count,
+        lastCountTimestamp: getStartOfDay(),
+    };
+    try {
+        core_1.defaultStorage.setItem(MESSAGE_DAILY_COUNT_KEY, JSON.stringify(dailyCount));
+    }
+    catch (err) {
+        logger.error('Failed to save daily message count to storage', err);
+    }
+}
+function setTotalCountMap(countMap) {
+    try {
+        core_1.defaultStorage.setItem(MESSAGE_TOTAL_COUNT_KEY, JSON.stringify(countMap));
+    }
+    catch (err) {
+        logger.error('Failed to save total count to storage', err);
+    }
+}
+async function setTotalCount(messageId, count) {
+    const totalCountMap = await getTotalCountMap();
+    const updatedMap = {
+        ...totalCountMap,
+        [messageId]: count,
+    };
+    setTotalCountMap(updatedMap);
+}
+async function getDailyCount() {
+    const today = getStartOfDay();
+    const item = await core_1.defaultStorage.getItem(MESSAGE_DAILY_COUNT_KEY);
+    // Parse stored count or initialize as empty count
+    const counter = item
+        ? JSON.parse(item)
+        : { count: 0, lastCountTimestamp: today };
+    // If the stored counter timestamp is today, use it as the count, otherwise reset to 0
+    return counter.lastCountTimestamp === today ? counter.count : 0;
+}
+async function getTotalCountMap() {
+    const item = await core_1.defaultStorage.getItem(MESSAGE_TOTAL_COUNT_KEY);
+    // Parse stored count map or initialize as empty
+    return item ? JSON.parse(item) : {};
+}
+async function getTotalCount(messageId) {
+    const countMap = await getTotalCountMap();
+    // Return stored count or initialize as empty count
+    return countMap[messageId] || 0;
+}
+const getStartOfDay = () => {
+    const now = new Date();
+    now.setHours(0, 0, 0, 0);
+    return now.toISOString();
+};

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

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

package/lib/inAppMessaging/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?.InAppMessaging?.Pinpoint ?? {};
+    (0, errors_1.assertValidationError)(!!appId, errors_1.InAppMessagingValidationErrorCode.NoAppId);
+    (0, errors_1.assertValidationError)(!!region, errors_1.InAppMessagingValidationErrorCode.NoRegion);
+    return { appId, region };
+};
+exports.resolveConfig = resolveConfig;

package/lib/inAppMessaging/providers/pinpoint/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/inAppMessaging/providers/pinpoint/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.assertValidationError)(!!credentials, errors_1.InAppMessagingValidationErrorCode.NoCredentials);
+    return { credentials, identityId };
+};
+exports.resolveCredentials = resolveCredentials;

package/lib/inAppMessaging/providers/pinpoint/utils/userAgent.d.ts

@@ -0,0 +1,4 @@
+import { InAppMessagingAction } from '@aws-amplify/core/internals/utils';
+import { UserAgent } from '@aws-sdk/types';
+export declare function getInAppMessagingUserAgent(action: InAppMessagingAction): UserAgent;
+export declare function getInAppMessagingUserAgentString(action: InAppMessagingAction): string;

package/lib/inAppMessaging/providers/pinpoint/utils/userAgent.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getInAppMessagingUserAgentString = exports.getInAppMessagingUserAgent = 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");
+function getInAppMessagingUserAgent(action) {
+    return (0, utils_1.getAmplifyUserAgentObject)({
+        category: utils_1.Category.InAppMessaging,
+        action,
+    });
+}
+exports.getInAppMessagingUserAgent = getInAppMessagingUserAgent;
+function getInAppMessagingUserAgentString(action) {
+    return (0, utils_1.getAmplifyUserAgent)({
+        category: utils_1.Category.InAppMessaging,
+        action,
+    });
+}
+exports.getInAppMessagingUserAgentString = getInAppMessagingUserAgentString;

package/lib/inAppMessaging/types/event.d.ts

@@ -0,0 +1,6 @@
+export type InAppMessageInteractionEvent = 'messageReceived' | 'messageDisplayed' | 'messageDismissed' | 'messageActionTaken';
+export type InAppMessagingEvent = {
+    name: string;
+    attributes?: Record<string, string>;
+    metrics?: Record<string, number>;
+};

package/lib/inAppMessaging/types/event.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/inAppMessaging/types/index.d.ts

@@ -0,0 +1,4 @@
+export { InAppMessagingServiceOptions } from './options';
+export { InAppMessagingIdentifyUserInput } from './inputs';
+export { InAppMessageInteractionEvent, InAppMessagingEvent } from './event';
+export { InAppMessage, InAppMessageAction, InAppMessageContent, InAppMessageLayout, InAppMessageTextAlign, InAppMessageButton, InAppMessageImage, InAppMessageStyle, } from './message';

package/lib/inAppMessaging/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/inAppMessaging/types/inputs.d.ts

@@ -0,0 +1,19 @@
+import { UserProfile } from '@aws-amplify/core';
+import { InAppMessagingServiceOptions } from '.';
+/**
+ * Input type for `identifyUser`.
+ */
+export type InAppMessagingIdentifyUserInput<ServiceOptions extends InAppMessagingServiceOptions = InAppMessagingServiceOptions> = {
+    /**
+     * 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;
+};

package/lib/inAppMessaging/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/inAppMessaging/types/message.d.ts

@@ -0,0 +1,44 @@
+export type InAppMessageLayout = 'BOTTOM_BANNER' | 'CAROUSEL' | 'FULL_SCREEN' | 'MIDDLE_BANNER' | 'MODAL' | 'TOP_BANNER';
+export type InAppMessageAction = 'CLOSE' | 'DEEP_LINK' | 'LINK';
+export type InAppMessageTextAlign = 'center' | 'left' | 'right';
+interface InAppMessageContainer {
+    style?: InAppMessageStyle;
+}
+interface InAppMessageHeader {
+    content: string;
+    style?: InAppMessageStyle;
+}
+interface InAppMessageBody {
+    content: string;
+    style?: InAppMessageStyle;
+}
+export interface InAppMessageImage {
+    src: string;
+}
+export interface InAppMessageButton {
+    title: string;
+    action: InAppMessageAction;
+    url?: string;
+    style?: InAppMessageStyle;
+}
+export interface InAppMessageStyle {
+    backgroundColor?: string;
+    borderRadius?: number;
+    color?: string;
+    textAlign?: InAppMessageTextAlign;
+}
+export interface InAppMessageContent {
+    container?: InAppMessageContainer;
+    header?: InAppMessageHeader;
+    body?: InAppMessageBody;
+    image?: InAppMessageImage;
+    primaryButton?: InAppMessageButton;
+    secondaryButton?: InAppMessageButton;
+}
+export interface InAppMessage {
+    id: string;
+    layout: InAppMessageLayout;
+    content: InAppMessageContent[];
+    metadata?: any;
+}
+export {};

package/lib/inAppMessaging/types/message.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/inAppMessaging/types/options.d.ts

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

package/lib/inAppMessaging/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 });