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

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

@@ -0,0 +1,108 @@
+// 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 {
+	updateEndpoint,
+	getEndpointId,
+} from '@aws-amplify/core/internals/providers/pinpoint';
+import { defaultStorage } from '@aws-amplify/core';
+import {
+	resolveConfig,
+	resolveCredentials,
+	getInAppMessagingUserAgentString,
+	STORAGE_KEY_SUFFIX,
+	PINPOINT_KEY_PREFIX,
+	CATEGORY,
+	CHANNEL_TYPE,
+} from '../utils';
+import {
+	getInAppMessages,
+	GetInAppMessagesInput,
+	GetInAppMessagesOutput,
+} from '@aws-amplify/core/internals/aws-clients/pinpoint';
+import {
+	InAppMessagingValidationErrorCode,
+	assertServiceError,
+	assertValidationError,
+} from '../../../errors';
+
+/**
+ * Fetch and persist messages from Pinpoint campaigns.
+ * Calling this API is necessary to trigger InApp messages on the device.
+ *
+ * @throws service exceptions - 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
+ * // Sync InApp messages with Pinpoint and device.
+ * await syncMessages();
+ *
+ * ```
+ */
+export async function syncMessages(): Promise<void> {
+	const messages = await fetchInAppMessages();
+	if (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;
+	}
+}
+
+async function fetchInAppMessages() {
+	try {
+		const { credentials, identityId } = await resolveCredentials();
+		const { appId, region } = resolveConfig();
+		let endpointId = await getEndpointId(appId, CATEGORY);
+
+		// Prepare a Pinpoint endpoint via updateEndpoint if one does not already exist, which will generate and cache an
+		// endpoint ID between calls
+		if (!endpointId) {
+			await updateEndpoint({
+				appId,
+				category: CATEGORY,
+				channelType: CHANNEL_TYPE,
+				credentials,
+				identityId,
+				region,
+				// TODO(V6): Update InAppMessagingAction.None
+				userAgentValue: getInAppMessagingUserAgentString(
+					InAppMessagingAction.None
+				),
+			});
+
+			endpointId = await getEndpointId(appId, CATEGORY);
+		}
+
+		assertValidationError(
+			!!endpointId,
+			InAppMessagingValidationErrorCode.NoEndpointId
+		);
+
+		const input: GetInAppMessagesInput = {
+			ApplicationId: appId,
+			EndpointId: endpointId,
+		};
+		const response: GetInAppMessagesOutput = await getInAppMessages(
+			{ credentials, region },
+			input
+		);
+		const { InAppMessageCampaigns: messages } = response.InAppMessagesResponse;
+		return messages;
+	} catch (error) {
+		assertServiceError(error);
+		throw error;
+	}
+}

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

@@ -1,4 +1,4 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-export { identifyUser } from './apis';
+export { identifyUser, syncMessages } from './apis';

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

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

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

@@ -0,0 +1,12 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { resolveConfig } from './resolveConfig';
+export { resolveCredentials } from './resolveCredentials';
+export { getInAppMessagingUserAgentString } from './userAgent';
+export {
+	PINPOINT_KEY_PREFIX,
+	CATEGORY,
+	CHANNEL_TYPE,
+	STORAGE_KEY_SUFFIX,
+} from './constants';

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

@@ -0,0 +1,19 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { Amplify } from '@aws-amplify/core';
+import {
+	InAppMessagingValidationErrorCode,
+	assertValidationError,
+} from '../../../errors';
+
+/**
+ * @internal
+ */
+export const resolveConfig = () => {
+	const { appId, region } =
+		Amplify.getConfig().Notifications?.InAppMessaging.Pinpoint ?? {};
+	assertValidationError(!!appId, InAppMessagingValidationErrorCode.NoAppId);
+	assertValidationError(!!region, InAppMessagingValidationErrorCode.NoRegion);
+	return { appId, region };
+};

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

@@ -0,0 +1,20 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { fetchAuthSession } from '@aws-amplify/core';
+import {
+	InAppMessagingValidationErrorCode,
+	assertValidationError,
+} from '../../../errors';
+
+/**
+ * @internal
+ */
+export const resolveCredentials = async () => {
+	const { credentials, identityId } = await fetchAuthSession();
+	assertValidationError(
+		!!credentials,
+		InAppMessagingValidationErrorCode.NoCredentials
+	);
+	return { credentials, identityId };
+};

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

@@ -0,0 +1,25 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import {
+	Category,
+	getAmplifyUserAgentObject,
+	getAmplifyUserAgent,
+	InAppMessagingAction,
+} from '@aws-amplify/core/internals/utils';
+import { UserAgent } from '@aws-sdk/types';
+
+export function getInAppMessagingUserAgent(
+	action: InAppMessagingAction
+): UserAgent {
+	return getAmplifyUserAgentObject({
+		category: Category.InAppMessaging,
+		action,
+	});
+}
+
+export function getInAppMessagingUserAgentString(action: InAppMessagingAction) {
+	return getAmplifyUserAgent({
+		category: Category.InAppMessaging,
+		action,
+	});
+}