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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/notifications",
-  "version": "2.0.1-console-preview.11cf989.0+11cf989",
+  "version": "2.0.1-console-preview.4ae78ed.0+4ae78ed",
   "description": "Notifications category of aws-amplify",
   "main": "./lib/index.js",
   "module": "./lib-esm/index.js",
@@ -101,10 +101,10 @@
     "uuid": "^9.0.0"
   },
   "peerDependencies": {
-    "@aws-amplify/core": "6.0.1-console-preview.11cf989.0+11cf989"
+    "@aws-amplify/core": "6.0.1-console-preview.4ae78ed.0+4ae78ed"
   },
   "devDependencies": {
-    "@aws-amplify/core": "6.0.1-console-preview.11cf989.0+11cf989",
+    "@aws-amplify/core": "6.0.1-console-preview.4ae78ed.0+4ae78ed",
     "@babel/core": "7.15.5",
     "@babel/plugin-proposal-class-properties": "^7.0.0",
     "@babel/plugin-proposal-private-methods": "^7.0.0",
@@ -125,5 +125,5 @@
       "limit": "29.95 kB"
     }
   ],
-  "gitHead": "11cf9890e0229d7f36a7b2375e57bc0decf9935a"
+  "gitHead": "4ae78ed23fc03ae718488c98fc48782d2bd6f5f3"
 }

package/src/common/AWSPinpointProviderCommon/index.ts

@@ -27,7 +27,7 @@ import {
 	NotificationsProvider,
 	UserInfo,
 } from '../../types';
-import { AWSPinpointUserInfo } from './types';
+import { PinpointUserInfo } from './types';
 
 export default abstract class AWSPinpointProviderCommon
 	implements NotificationsProvider
@@ -115,7 +115,7 @@ export default abstract class AWSPinpointProviderCommon
 		} else {
 			customUserAgentDetails = {
 				category: Category.InAppMessaging,
-				action: InAppMessagingAction.None,
+				action: InAppMessagingAction.IdentifyUser,
 			};
 		}
 
@@ -159,7 +159,7 @@ export default abstract class AWSPinpointProviderCommon
 
 	protected updateEndpoint = async (
 		userId: string = null,
-		userInfo: AWSPinpointUserInfo = null
+		userInfo: PinpointUserInfo = null
 	): Promise<void> => {
 		const credentials = await this.getCredentials();
 		// Shallow compare to determine if credentials stored here are outdated

package/src/common/AWSPinpointProviderCommon/types.ts

@@ -3,12 +3,12 @@
 
 import { UserInfo } from '../../types';
 
-export interface AWSPinpointProviderConfig {
+export interface PinpointProviderConfig {
 	appId: string;
 	region: string;
 }
 
-export interface AWSPinpointUserInfo extends UserInfo {
+export interface PinpointUserInfo extends UserInfo {
 	address?: string;
 	optOut?: 'ALL' | 'NONE';
 }

package/src/inAppMessaging/index.ts

@@ -2,16 +2,3 @@
 // SPDX-License-Identifier: Apache-2.0
 
 export { identifyUser, syncMessages } from './providers/pinpoint';
-export {
-	InAppMessage,
-	InAppMessageAction,
-	InAppMessageButton,
-	InAppMessageContent,
-	InAppMessageImage,
-	InAppMessageInteractionEvent,
-	InAppMessageLayout,
-	InAppMessageStyle,
-	InAppMessageTextAlign,
-	InAppMessagingConfig,
-	InAppMessagingEvent,
-} from './types';

package/src/inAppMessaging/providers/pinpoint/apis/identifyUser.ts

@@ -1,11 +1,94 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { UserInfo } from '../../../../types';
+import { InAppMessagingAction } from '@aws-amplify/core/internals/utils';
+import { updateEndpoint } from '@aws-amplify/core/internals/providers/pinpoint';
+import { InAppMessagingValidationErrorCode } from '../../../errors';
+import {
+	CATEGORY,
+	CHANNEL_TYPE,
+	getInAppMessagingUserAgentString,
+	resolveConfig,
+	resolveCredentials,
+} from '../utils';
+import { IdentifyUserInput } from '../types';
 
-export function identifyUser(
-	userId: string,
-	userInfo: UserInfo
-): Promise<void> {
-	throw new Error('WIP');
-}
+/**
+ * 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
+ * the same `userId`.
+ *
+ * @param {IdentifyUserParameters} params The input object used to construct requests sent to Pinpoint's UpdateEndpoint
+ *  API.
+ *
+ * @throws service: {@link UpdateEndpointException} - Thrown when the underlying Pinpoint service returns an error.
+ * @throws validation: {@link InAppMessagingValidationErrorCode} - Thrown when the provided parameters or library
+ *  configuration is incorrect.
+ *
+ * @returns A promise that will resolve when the operation is complete.
+ *
+ * @example
+ * ```ts
+ * // Identify a user with Pinpoint
+ * await identifyUser({
+ *     userId,
+ *     userProfile: {
+ *         email: 'userEmail@example.com'
+ *         customProperties: {
+ *             phoneNumber: ['555-555-5555'],
+ *         },
+ *     }
+ * });
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Identify a user with Pinpoint specific options
+ * await identifyUser({
+ *     userId,
+ *     userProfile: {
+ *         email: 'userEmail@example.com'
+ *         customProperties: {
+ *             phoneNumber: ['555-555-5555'],
+ *         },
+ *         demographic: {
+ *             platform: 'ios',
+ *             timezone: 'America/Los_Angeles'
+ *         }
+ *     },
+ *     options: {
+ *         serviceOptions: {
+ *             address: 'device-address',
+ *             optOut: 'NONE',
+ * 			   userAttributes: {
+ * 			      interests: ['food']
+ * 			   },
+ *         },
+ *     },
+ * });
+ */
+export const identifyUser = async ({
+	userId,
+	userProfile,
+	options,
+}: IdentifyUserInput): Promise<void> => {
+	const { credentials, identityId } = await resolveCredentials();
+	const { appId, region } = resolveConfig();
+	const { address, optOut, userAttributes } = options?.serviceOptions ?? {};
+	updateEndpoint({
+		address,
+		channelType: CHANNEL_TYPE,
+		optOut,
+		appId,
+		category: CATEGORY,
+		credentials,
+		identityId,
+		region,
+		userAttributes,
+		userId,
+		userProfile,
+		userAgentValue: getInAppMessagingUserAgentString(
+			InAppMessagingAction.IdentifyUser
+		),
+	});
+};

package/src/inAppMessaging/providers/pinpoint/apis/syncMessages.ts

@@ -1,10 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import {
-	InAppMessagingAction,
-	ConsoleLogger as Logger,
-} from '@aws-amplify/core/internals/utils';
+import { InAppMessagingAction } from '@aws-amplify/core/internals/utils';
 import {
 	updateEndpoint,
 	getEndpointId,
@@ -77,9 +74,8 @@ async function fetchInAppMessages() {
 				credentials,
 				identityId,
 				region,
-				// TODO(V6): Update InAppMessagingAction.None
 				userAgentValue: getInAppMessagingUserAgentString(
-					InAppMessagingAction.None
+					InAppMessagingAction.SyncMessages
 				),
 			});
 

package/src/inAppMessaging/providers/pinpoint/types/errors.ts

@@ -0,0 +1,12 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export enum UpdateEndpointException {
+	BadRequestException = 'BadRequestException',
+	ForbiddenException = 'ForbiddenException',
+	InternalServerErrorException = 'InternalServerErrorException',
+	MethodNotAllowedException = 'MethodNotAllowedException',
+	NotFoundException = 'NotFoundException',
+	PayloadTooLargeException = 'PayloadTooLargeException',
+	TooManyRequestsException = 'TooManyRequestsException',
+}

package/src/inAppMessaging/providers/pinpoint/types/index.ts

@@ -0,0 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { UpdateEndpointException } from './errors';
+export { IdentifyUserInput } from './inputs';
+export { IdentifyUserOptions } from './options';

package/src/inAppMessaging/providers/pinpoint/types/inputs.ts

@@ -0,0 +1,11 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { IdentifyUserOptions } from '.';
+import { InAppMessagingIdentifyUserInput } from '../../../types';
+
+/**
+ * Input type for Pinpoint identifyUser API.
+ */
+export type IdentifyUserInput =
+	InAppMessagingIdentifyUserInput<IdentifyUserOptions>;

package/src/inAppMessaging/providers/pinpoint/types/options.ts

@@ -0,0 +1,9 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { PinpointServiceOptions } from '@aws-amplify/core/internals/providers/pinpoint';
+
+/**
+ * Options specific to Pinpoint identityUser.
+ */
+export type IdentifyUserOptions = PinpointServiceOptions;

package/src/inAppMessaging/types/config.ts

@@ -0,0 +1,8 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { PinpointProviderConfig } from '../../common/AWSPinpointProviderCommon/types';
+
+export interface InAppMessagingConfig {
+	listenForAnalyticsEvents?: boolean;
+	AWSPinpoint?: PinpointProviderConfig;
+}

package/src/inAppMessaging/types/event.ts

@@ -0,0 +1,14 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export type InAppMessageInteractionEvent =
+	| 'messageReceived'
+	| 'messageDisplayed'
+	| 'messageDismissed'
+	| 'messageActionTaken';
+
+export type InAppMessagingEvent = {
+	name: string;
+	attributes?: Record<string, string>;
+	metrics?: Record<string, number>;
+};

package/src/inAppMessaging/types/index.ts

@@ -0,0 +1,8 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { InAppMessagingServiceOptions } from './options';
+export { InAppMessagingIdentifyUserInput } from './inputs';
+export { InAppMessagingConfig } from './config';
+export { InAppMessageInteractionEvent, InAppMessagingEvent } from './event';
+export { InAppMessage } from './message';

package/src/inAppMessaging/types/inputs.ts

@@ -0,0 +1,29 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+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?: ServiceOptions;
+	};
+};

package/src/inAppMessaging/types/message.ts

@@ -0,0 +1,62 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+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;
+}

package/src/inAppMessaging/types/options.ts

@@ -0,0 +1,7 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * Base type for service options.
+ */
+export type InAppMessagingServiceOptions = any;

package/src/index.ts

@@ -2,20 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 export { AWSPinpointProviderCommon } from './common';
-export { AWSPinpointUserInfo } from './common/AWSPinpointProviderCommon/types';
-export {
-	InAppMessage,
-	InAppMessageAction,
-	InAppMessageButton,
-	InAppMessageContent,
-	InAppMessageImage,
-	InAppMessageInteractionEvent,
-	InAppMessageLayout,
-	InAppMessageStyle,
-	InAppMessageTextAlign,
-	InAppMessagingConfig,
-	InAppMessagingEvent,
-} from './inAppMessaging';
+export { PinpointUserInfo } from './common/AWSPinpointProviderCommon/types';
 export {
 	PushNotificationMessage,
 	PushNotificationPermissions,

package/src/pushNotifications/providers/AWSPinpointProvider/index.ts

@@ -3,16 +3,13 @@
 
 import { addEventListener, AWSPinpointProviderCommon } from '../../../common';
 import { ChannelType } from '../../../common/AWSPinpointProviderCommon/types';
-import PlatformNotSupportedError from '../../PlatformNotSupportedError';
-import { Platform } from '../../Platform';
 import {
-	PushNotificationEvent,
 	PushNotificationMessage,
 	PushNotificationProvider,
 	NotificationsSubCategory,
 } from '../../types';
 import { AWSPinpointMessageEvent } from './types';
-import { getAnalyticsEvent, logger } from './utils';
+import { logger } from './utils';
 
 export default class AWSPinpointProvider
 	extends AWSPinpointProviderCommon
@@ -42,24 +39,20 @@ export default class AWSPinpointProvider
 		// some configuration steps should not be re-run even if provider is re-configured for some reason
 		if (!this.configured) {
 			// wire up default Pinpoint message event handling
-			addEventListener(
-				PushNotificationEvent.BACKGROUND_MESSAGE_RECEIVED,
-				message =>
-					this.recordMessageEvent(
-						message,
-						AWSPinpointMessageEvent.BACKGROUND_MESSAGE_RECEIVED
-					)
+			addEventListener('backgroundMessageReceived', message =>
+				this.recordMessageEvent(
+					message,
+					AWSPinpointMessageEvent.BACKGROUND_MESSAGE_RECEIVED
+				)
 			);
-			addEventListener(
-				PushNotificationEvent.FOREGROUND_MESSAGE_RECEIVED,
-				message =>
-					this.recordMessageEvent(
-						message,
-						AWSPinpointMessageEvent.FOREGROUND_MESSAGE_RECEIVED
-					)
+			addEventListener('foregroundMessageReceived', message =>
+				this.recordMessageEvent(
+					message,
+					AWSPinpointMessageEvent.FOREGROUND_MESSAGE_RECEIVED
+				)
 			);
 			const launchNotificationOpenedListener = addEventListener(
-				PushNotificationEvent.LAUNCH_NOTIFICATION_OPENED,
+				'launchNotificationsOpened',
 				message => {
 					this.recordMessageEvent(
 						message,
@@ -69,7 +62,7 @@ export default class AWSPinpointProvider
 					launchNotificationOpenedListener?.remove();
 				}
 			);
-			addEventListener(PushNotificationEvent.NOTIFICATION_OPENED, message => {
+			addEventListener('notificationOpened', message => {
 				this.recordMessageEvent(
 					message,
 					AWSPinpointMessageEvent.NOTIFICATION_OPENED

package/src/pushNotifications/types.ts

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { EventListener } from '../common';
-import { AWSPinpointProviderConfig } from '../common/AWSPinpointProviderCommon/types';
+import { PinpointProviderConfig } from '../common/AWSPinpointProviderCommon/types';
 import {
 	NotificationsProvider,
 	NotificationsSubCategory as NotificationsSubCategories,
@@ -52,7 +52,7 @@ export interface PushNotificationProvider extends NotificationsProvider {
 }
 
 export interface PushNotificationConfig {
-	AWSPinpoint?: AWSPinpointProviderConfig;
+	Pinpoint?: PinpointProviderConfig;
 }
 
 export interface PushNotificationMessage {
@@ -97,13 +97,12 @@ export type OnPushNotificationMessageHandler = (
 	message: PushNotificationMessage
 ) => any;
 
-export const enum PushNotificationEvent {
-	BACKGROUND_MESSAGE_RECEIVED,
-	FOREGROUND_MESSAGE_RECEIVED,
-	LAUNCH_NOTIFICATION_OPENED,
-	NOTIFICATION_OPENED,
-	TOKEN_RECEIVED,
-}
+export type PushNotificationEvent =
+	| 'backgroundMessageReceived'
+	| 'foregroundMessageReceived'
+	| 'launchNotificationsOpened'
+	| 'notificationOpened'
+	| 'tokenReceived';
 
 export interface NormalizedValues {
 	body?: string;

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

@@ -1,17 +0,0 @@
-import { ConsoleLogger } from '@aws-amplify/core/internals/utils';
-import type { InAppMessageCampaign as PinpointInAppMessage } from '@aws-amplify/core/internals/aws-clients/pinpoint';
-import { InAppMessage, InAppMessageContent, InAppMessageLayout, InAppMessagingEvent } from '../../../types';
-import { AWSPinpointMessageEvent, MetricsComparator } from '../types/types';
-export declare const logger: ConsoleLogger;
-export declare const recordAnalyticsEvent: (event: AWSPinpointMessageEvent, message: InAppMessage) => void;
-export declare const getStartOfDay: () => string;
-export declare const matchesEventType: ({ CampaignId, Schedule }: PinpointInAppMessage, { name: eventType }: InAppMessagingEvent) => any;
-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 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 extractContent: ({ InAppMessage: message, }: PinpointInAppMessage) => InAppMessageContent[];
-export declare const extractMetadata: ({ InAppMessage, Priority, Schedule, TreatmentId, }: PinpointInAppMessage) => any;