@aws-amplify/notifications 2.0.1-console-preview.11cf989.0 → 2.0.1-console-preview.4ae78ed.0

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

@@ -1,87 +0,0 @@
-import { EventListener } from '../common';
-import { AWSPinpointProviderConfig } from '../common/AWSPinpointProviderCommon/types';
-import { NotificationsProvider, NotificationsSubCategory as NotificationsSubCategories, UserInfo } from '../types';
-export declare type NotificationsSubCategory = Extract<NotificationsSubCategories, 'InAppMessaging'>;
-export interface InAppMessagingInterface {
-    configure: (config: InAppMessagingConfig) => InAppMessagingConfig;
-    getModuleName: () => NotificationsSubCategory;
-    getPluggable: (providerName: string) => InAppMessagingProvider;
-    addPluggable: (pluggable: InAppMessagingProvider) => void;
-    removePluggable: (providerName: string) => void;
-    syncMessages: () => Promise<void[]>;
-    clearMessages: () => Promise<void[]>;
-    dispatchEvent: (event: InAppMessagingEvent) => Promise<void>;
-    identifyUser: (userId: string, userInfo: UserInfo) => Promise<void[]>;
-    onMessageReceived: (handler: OnMessageInteractionEventHandler) => EventListener<OnMessageInteractionEventHandler>;
-    onMessageDisplayed: (handler: OnMessageInteractionEventHandler) => EventListener<OnMessageInteractionEventHandler>;
-    onMessageDismissed: (handler: OnMessageInteractionEventHandler) => EventListener<OnMessageInteractionEventHandler>;
-    onMessageActionTaken: (handler: OnMessageInteractionEventHandler) => EventListener<OnMessageInteractionEventHandler>;
-    notifyMessageInteraction: (message: InAppMessage, type: InAppMessageInteractionEvent) => void;
-    setConflictHandler: (handler: InAppMessageConflictHandler) => void;
-}
-export interface InAppMessagingProvider extends NotificationsProvider {
-    getSubCategory(): NotificationsSubCategory;
-    getInAppMessages(): Promise<any>;
-    processInAppMessages(messages: InAppMessage[], event: InAppMessagingEvent): Promise<InAppMessage[]>;
-}
-export interface InAppMessagingConfig {
-    listenForAnalyticsEvents?: boolean;
-    AWSPinpoint?: AWSPinpointProviderConfig;
-}
-export declare type InAppMessagingEvent = {
-    name: string;
-    attributes?: Record<string, string>;
-    metrics?: Record<string, number>;
-};
-export declare type InAppMessageLayout = 'BOTTOM_BANNER' | 'CAROUSEL' | 'FULL_SCREEN' | 'MIDDLE_BANNER' | 'MODAL' | 'TOP_BANNER';
-export declare type InAppMessageAction = 'CLOSE' | 'DEEP_LINK' | 'LINK';
-export declare 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 declare type OnMessageInteractionEventHandler = (message: InAppMessage) => any;
-export declare enum InAppMessageInteractionEvent {
-    MESSAGE_RECEIVED = "MESSAGE_RECEIVED_EVENT",
-    MESSAGE_DISPLAYED = "MESSAGE_DISPLAYED_EVENT",
-    MESSAGE_DISMISSED = "MESSAGE_DISMISSED_EVENT",
-    MESSAGE_ACTION_TAKEN = "MESSAGE_ACTION_TAKEN_EVENT"
-}
-export declare type InAppMessageConflictHandler = (messages: InAppMessage[]) => InAppMessage;
-export {};

package/lib-esm/inAppMessaging/types.js

@@ -1,10 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-export var InAppMessageInteractionEvent;
-(function (InAppMessageInteractionEvent) {
-    InAppMessageInteractionEvent["MESSAGE_RECEIVED"] = "MESSAGE_RECEIVED_EVENT";
-    InAppMessageInteractionEvent["MESSAGE_DISPLAYED"] = "MESSAGE_DISPLAYED_EVENT";
-    InAppMessageInteractionEvent["MESSAGE_DISMISSED"] = "MESSAGE_DISMISSED_EVENT";
-    InAppMessageInteractionEvent["MESSAGE_ACTION_TAKEN"] = "MESSAGE_ACTION_TAKEN_EVENT";
-})(InAppMessageInteractionEvent || (InAppMessageInteractionEvent = {}));
-//# sourceMappingURL=types.js.map

package/lib-esm/inAppMessaging/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/inAppMessaging/types.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC;AAmItC,MAAM,CAAN,IAAY,4BAKX;AALD,WAAY,4BAA4B;IACvC,2EAA2C,CAAA;IAC3C,6EAA6C,CAAA;IAC7C,6EAA6C,CAAA;IAC7C,mFAAmD,CAAA;AACpD,CAAC,EALW,4BAA4B,KAA5B,4BAA4B,QAKvC"}

package/src/inAppMessaging/providers/pinpoint/utils/utils.ts

@@ -1,304 +0,0 @@
-// 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 type { InAppMessageCampaign as PinpointInAppMessage } from '@aws-amplify/core/internals/aws-clients/pinpoint';
-import isEmpty from 'lodash/isEmpty';
-import {
-	InAppMessage,
-	InAppMessageAction,
-	InAppMessageContent,
-	InAppMessageLayout,
-	InAppMessageTextAlign,
-	InAppMessagingEvent,
-} from '../../../types';
-
-import { AWSPinpointMessageEvent, MetricsComparator } from '../types/types';
-
-const DELIVERY_TYPE = 'IN_APP_MESSAGE';
-
-let eventNameMemo = {};
-let eventAttributesMemo = {};
-let eventMetricsMemo = {};
-
-export const logger = new ConsoleLogger('InAppMessaging.AWSPinpointProvider');
-
-export const recordAnalyticsEvent = (
-	event: AWSPinpointMessageEvent,
-	message: InAppMessage
-) => {
-	// TODO(V6) : Add back recording here without validation
-	// if (Amplify.Analytics && typeof Amplify.Analytics.record === 'function') {
-	// 	const { id, metadata } = message;
-	// 	Amplify.Analytics.record({
-	// 		name: event,
-	// 		attributes: {
-	// 			campaign_id: id,
-	// 			delivery_type: DELIVERY_TYPE,
-	// 			treatment_id: metadata?.treatmentId,
-	// 		},
-	// 	});
-	// } else {
-	// 	logger.debug('Analytics module is not registered into Amplify');
-	// }
-};
-
-export const getStartOfDay = (): string => {
-	const now = new Date();
-	now.setHours(0, 0, 0, 0);
-	return now.toISOString();
-};
-
-export const matchesEventType = (
-	{ CampaignId, Schedule }: PinpointInAppMessage,
-	{ name: eventType }: InAppMessagingEvent
-) => {
-	const { EventType } = Schedule?.EventFilter?.Dimensions;
-	const memoKey = `${CampaignId}:${eventType}`;
-	if (!eventNameMemo.hasOwnProperty(memoKey)) {
-		eventNameMemo[memoKey] = !!EventType?.Values.includes(eventType);
-	}
-	return eventNameMemo[memoKey];
-};
-
-export const matchesAttributes = (
-	{ CampaignId, Schedule }: PinpointInAppMessage,
-	{ attributes }: InAppMessagingEvent
-): boolean => {
-	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;
-	}
-	if (isEmpty(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] = Object.entries(Attributes).every(
-			([key, { Values }]) => Values.includes(attributes[key])
-		);
-	}
-	return eventAttributesMemo[memoKey];
-};
-
-export const matchesMetrics = (
-	{ CampaignId, Schedule }: PinpointInAppMessage,
-	{ metrics }: InAppMessagingEvent
-): boolean => {
-	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;
-	}
-	if (isEmpty(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] = 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 ? compare(Value, metrics[key]) : false;
-			}
-		);
-	}
-	return eventMetricsMemo[memoKey];
-};
-
-export const getComparator = (operator: string): MetricsComparator => {
-	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 null;
-	}
-};
-
-export const isBeforeEndDate = ({
-	Schedule,
-}: PinpointInAppMessage): boolean => {
-	if (!Schedule?.EndDate) {
-		return true;
-	}
-	return new Date() < new Date(Schedule.EndDate);
-};
-
-export const isQuietTime = (message: PinpointInAppMessage): boolean => {
-	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) {
-		logger.debug('message filtered due to quiet time', message);
-	}
-	return isQuietTime;
-};
-
-export const clearMemo = () => {
-	eventNameMemo = {};
-	eventAttributesMemo = {};
-	eventMetricsMemo = {};
-};
-
-// 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
-export const interpretLayout = (
-	layout: PinpointInAppMessage['InAppMessage']['Layout']
-): InAppMessageLayout => {
-	if (layout === 'MOBILE_FEED') {
-		return 'MODAL';
-	}
-
-	if (layout === 'OVERLAYS') {
-		return 'FULL_SCREEN';
-	}
-
-	// cast as PinpointInAppMessage['InAppMessage']['Layout'] allows `string` as a value
-	return layout as InAppMessageLayout;
-};
-
-export const extractContent = ({
-	InAppMessage: message,
-}: PinpointInAppMessage): InAppMessageContent[] => {
-	return (
-		message?.Content?.map(content => {
-			const {
-				BackgroundColor,
-				BodyConfig,
-				HeaderConfig,
-				ImageUrl,
-				PrimaryBtn,
-				SecondaryBtn,
-			} = content;
-			const defaultPrimaryButton = PrimaryBtn?.DefaultConfig;
-			const defaultSecondaryButton = SecondaryBtn?.DefaultConfig;
-			const extractedContent: InAppMessageContent = {};
-			if (BackgroundColor) {
-				extractedContent.container = {
-					style: {
-						backgroundColor: BackgroundColor,
-					},
-				};
-			}
-			if (HeaderConfig) {
-				extractedContent.header = {
-					content: HeaderConfig.Header,
-					style: {
-						color: HeaderConfig.TextColor,
-						textAlign:
-							HeaderConfig.Alignment.toLowerCase() as InAppMessageTextAlign,
-					},
-				};
-			}
-			if (BodyConfig) {
-				extractedContent.body = {
-					content: BodyConfig.Body,
-					style: {
-						color: BodyConfig.TextColor,
-						textAlign:
-							BodyConfig.Alignment.toLowerCase() as InAppMessageTextAlign,
-					},
-				};
-			}
-			if (ImageUrl) {
-				extractedContent.image = {
-					src: ImageUrl,
-				};
-			}
-			if (defaultPrimaryButton) {
-				extractedContent.primaryButton = {
-					title: defaultPrimaryButton.Text,
-					action: defaultPrimaryButton.ButtonAction as InAppMessageAction,
-					url: defaultPrimaryButton.Link,
-					style: {
-						backgroundColor: defaultPrimaryButton.BackgroundColor,
-						borderRadius: defaultPrimaryButton.BorderRadius,
-						color: defaultPrimaryButton.TextColor,
-					},
-				};
-			}
-			if (defaultSecondaryButton) {
-				extractedContent.secondaryButton = {
-					title: defaultSecondaryButton.Text,
-					action: defaultSecondaryButton.ButtonAction as InAppMessageAction,
-					url: defaultSecondaryButton.Link,
-					style: {
-						backgroundColor: defaultSecondaryButton.BackgroundColor,
-						borderRadius: defaultSecondaryButton.BorderRadius,
-						color: defaultSecondaryButton.TextColor,
-					},
-				};
-			}
-			return extractedContent;
-		}) ?? []
-	);
-};
-
-export const extractMetadata = ({
-	InAppMessage,
-	Priority,
-	Schedule,
-	TreatmentId,
-}: PinpointInAppMessage): InAppMessage['metadata'] => ({
-	customData: InAppMessage?.CustomConfig,
-	endDate: Schedule?.EndDate,
-	priority: Priority,
-	treatmentId: TreatmentId,
-});

package/src/inAppMessaging/types.ts

@@ -1,142 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import { EventListener } from '../common';
-import { AWSPinpointProviderConfig } from '../common/AWSPinpointProviderCommon/types';
-import {
-	NotificationsProvider,
-	NotificationsSubCategory as NotificationsSubCategories,
-	UserInfo,
-} from '../types';
-
-export type NotificationsSubCategory = Extract<
-	NotificationsSubCategories,
-	'InAppMessaging'
->;
-
-export interface InAppMessagingInterface {
-	configure: (config: InAppMessagingConfig) => InAppMessagingConfig;
-	getModuleName: () => NotificationsSubCategory;
-	getPluggable: (providerName: string) => InAppMessagingProvider;
-	addPluggable: (pluggable: InAppMessagingProvider) => void;
-	removePluggable: (providerName: string) => void;
-	syncMessages: () => Promise<void[]>;
-	clearMessages: () => Promise<void[]>;
-	dispatchEvent: (event: InAppMessagingEvent) => Promise<void>;
-	identifyUser: (userId: string, userInfo: UserInfo) => Promise<void[]>;
-	onMessageReceived: (
-		handler: OnMessageInteractionEventHandler
-	) => EventListener<OnMessageInteractionEventHandler>;
-	onMessageDisplayed: (
-		handler: OnMessageInteractionEventHandler
-	) => EventListener<OnMessageInteractionEventHandler>;
-	onMessageDismissed: (
-		handler: OnMessageInteractionEventHandler
-	) => EventListener<OnMessageInteractionEventHandler>;
-	onMessageActionTaken: (
-		handler: OnMessageInteractionEventHandler
-	) => EventListener<OnMessageInteractionEventHandler>;
-	notifyMessageInteraction: (
-		message: InAppMessage,
-		type: InAppMessageInteractionEvent
-	) => void;
-	setConflictHandler: (handler: InAppMessageConflictHandler) => void;
-}
-
-export interface InAppMessagingProvider extends NotificationsProvider {
-	// return sub-category ('InAppMessaging')
-	getSubCategory(): NotificationsSubCategory;
-
-	// get in-app messages from provider
-	getInAppMessages(): Promise<any>;
-
-	// filters in-app messages based on event input and provider logic
-	processInAppMessages(
-		messages: InAppMessage[],
-		event: InAppMessagingEvent
-	): Promise<InAppMessage[]>;
-}
-
-export interface InAppMessagingConfig {
-	listenForAnalyticsEvents?: boolean;
-	AWSPinpoint?: AWSPinpointProviderConfig;
-}
-
-export type InAppMessagingEvent = {
-	name: string;
-	attributes?: Record<string, string>;
-	metrics?: Record<string, number>;
-};
-
-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 type OnMessageInteractionEventHandler = (message: InAppMessage) => any;
-
-export enum InAppMessageInteractionEvent {
-	MESSAGE_RECEIVED = 'MESSAGE_RECEIVED_EVENT',
-	MESSAGE_DISPLAYED = 'MESSAGE_DISPLAYED_EVENT',
-	MESSAGE_DISMISSED = 'MESSAGE_DISMISSED_EVENT',
-	MESSAGE_ACTION_TAKEN = 'MESSAGE_ACTION_TAKEN_EVENT',
-}
-
-export type InAppMessageConflictHandler = (
-	messages: InAppMessage[]
-) => InAppMessage;