@aws-amplify/notifications 1.6.6-api-v6-models.3f48fe3.0 → 2.0.1-console-preview.11cf989.0

package/src/{InAppMessaging/Providers/AWSPinpointProvider → inAppMessaging/providers/pinpoint/utils}/utils.ts

@@ -1,10 +1,9 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { Amplify, ConsoleLogger, Hub } from '@aws-amplify/core';
+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 { AMPLIFY_SYMBOL } from '../../../common';
 import {
 	InAppMessage,
 	InAppMessageAction,
@@ -12,9 +11,9 @@ import {
 	InAppMessageLayout,
 	InAppMessageTextAlign,
 	InAppMessagingEvent,
-} from '../../types';
+} from '../../../types';
 
-import { AWSPinpointMessageEvent, MetricsComparator } from './types';
+import { AWSPinpointMessageEvent, MetricsComparator } from '../types/types';
 
 const DELIVERY_TYPE = 'IN_APP_MESSAGE';
 
@@ -24,36 +23,24 @@ let eventMetricsMemo = {};
 
 export const logger = new ConsoleLogger('InAppMessaging.AWSPinpointProvider');
 
-export const dispatchInAppMessagingEvent = (
-	event: string,
-	data: any,
-	message?: string
-) => {
-	Hub.dispatch(
-		'inAppMessaging',
-		{ event, data, message },
-		'InAppMessaging',
-		AMPLIFY_SYMBOL
-	);
-};
-
 export const recordAnalyticsEvent = (
 	event: AWSPinpointMessageEvent,
 	message: InAppMessage
 ) => {
-	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');
-	}
+	// 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 => {

package/src/{InAppMessaging/SessionTracker → inAppMessaging/sessionTracker}/SessionTracker.native.ts

@@ -1,7 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { ConsoleLogger as Logger } from '@aws-amplify/core';
+import { ConsoleLogger as Logger } from '@aws-amplify/core/internals/utils';
 import { AppState, AppStateStatus } from 'react-native';
 import noop from 'lodash/noop';
 import {

package/src/{InAppMessaging/SessionTracker → inAppMessaging/sessionTracker}/SessionTracker.ts

@@ -1,6 +1,9 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { browserOrNode, ConsoleLogger as Logger } from '@aws-amplify/core';
+import {
+	ConsoleLogger as Logger,
+	isBrowser,
+} from '@aws-amplify/core/internals/utils';
 import noop from 'lodash/noop';
 import {
 	SessionState,
@@ -11,7 +14,6 @@ import {
 // Per https://developer.mozilla.org/en-US/docs/Web/API/Page_Visibility_API
 let hidden: string;
 let visibilityChange: string;
-const { isBrowser } = browserOrNode();
 
 if (isBrowser && document) {
 	if (typeof document.hidden !== 'undefined') {

package/src/index.ts

@@ -1,8 +1,6 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-export { default as Notifications } from './Notifications';
-
 export { AWSPinpointProviderCommon } from './common';
 export { AWSPinpointUserInfo } from './common/AWSPinpointProviderCommon/types';
 export {
@@ -17,10 +15,10 @@ export {
 	InAppMessageTextAlign,
 	InAppMessagingConfig,
 	InAppMessagingEvent,
-} from './InAppMessaging';
+} from './inAppMessaging';
 export {
 	PushNotificationMessage,
 	PushNotificationPermissions,
 	PushNotificationPermissionStatus,
-} from './PushNotification/types';
+} from './pushNotifications/types';
 export { NotificationsConfig, UserInfo } from './types';

package/src/{PushNotification → pushNotifications}/index.ts

@@ -1,7 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-export { default } from './PushNotification';
+export { identifyUser } from './providers/pinpoint';
 export {
 	PushNotificationEvent,
 	PushNotificationMessage,

package/src/{PushNotification/Providers → pushNotifications/providers}/AWSPinpointProvider/index.ts

@@ -12,11 +12,7 @@ import {
 	NotificationsSubCategory,
 } from '../../types';
 import { AWSPinpointMessageEvent } from './types';
-import {
-	dispatchPushNotificationEvent,
-	getAnalyticsEvent,
-	logger,
-} from './utils';
+import { getAnalyticsEvent, logger } from './utils';
 
 export default class AWSPinpointProvider
 	extends AWSPinpointProviderCommon
@@ -84,54 +80,21 @@ export default class AWSPinpointProvider
 		}
 
 		this.configured = true;
-		dispatchPushNotificationEvent('pinpointProvider_configured', null);
 		return this.config;
 	};
 
 	registerDevice = async (address: string): Promise<void> => {
-		if (!this.initialized) {
-			await this.init();
-		}
-		try {
-			this.config.endpointInfo = {
-				...this.config.endpointInfo,
-				address,
-			};
-			await this.updateEndpoint();
-		} catch (err) {
-			this.logger.error('Error registering device', err);
-			throw err;
-		}
+		throw new Error('WIP');
 	};
 
 	private getChannelType = (): ChannelType => {
-		switch (Platform.OS) {
-			case 'android': {
-				// FCM was previously known as GCM and continues to be the channel type in Pinpoint
-				return 'GCM';
-			}
-			case 'ios': {
-				// If building in debug mode, use the APNs sandbox
-				return global['__DEV__'] ? 'APNS_SANDBOX' : 'APNS';
-			}
-			default: {
-				throw new PlatformNotSupportedError();
-			}
-		}
+		throw new Error('WIP');
 	};
 
 	private recordMessageEvent = async (
 		message: PushNotificationMessage,
 		event: AWSPinpointMessageEvent
 	): Promise<void> => {
-		const analyticsEvent = getAnalyticsEvent(message, event);
-		if (!analyticsEvent) {
-			logger.debug('A notification missing event information was not recorded');
-			return;
-		}
-		if (!this.initialized) {
-			await this.init();
-		}
-		return this.recordAnalyticsEvent(analyticsEvent);
+		throw new Error('WIP');
 	};
 }

package/src/{PushNotification/Providers → pushNotifications/providers}/AWSPinpointProvider/utils.ts

@@ -2,8 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import type { Event as AWSPinpointAnalyticsEvent } from '@aws-amplify/core/internals/aws-clients/pinpoint';
-import { ConsoleLogger, Hub } from '@aws-amplify/core';
-import { AMPLIFY_SYMBOL } from '../../../common';
+import { ConsoleLogger } from '@aws-amplify/core/internals/utils';
 import { PushNotificationMessage } from '../../types';
 import {
 	AWSPinpointMessageEventSource,
@@ -17,19 +16,6 @@ const ANDROID_CAMPAIGN_TREATMENT_ID_KEY = 'pinpoint.campaign.treatment_id';
 
 export const logger = new ConsoleLogger('PushNotification.AWSPinpointProvider');
 
-export const dispatchPushNotificationEvent = (
-	event: string,
-	data: any,
-	message?: string
-) => {
-	Hub.dispatch(
-		'pushNotification',
-		{ event, data, message },
-		'PushNotification',
-		AMPLIFY_SYMBOL
-	);
-};
-
 export const getAnalyticsEvent = (
 	{ data }: PushNotificationMessage,
 	event: AWSPinpointMessageEvent

package/src/pushNotifications/providers/index.ts

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

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

@@ -0,0 +1,11 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { UserInfo } from '../../../../types';
+
+export function identifyUser(
+	userId: string,
+	userInfo: UserInfo
+): Promise<void> {
+	throw new Error('WIP');
+}

package/src/pushNotifications/providers/pinpoint/apis/index.ts

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

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

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

package/src/types.ts

@@ -1,8 +1,8 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { InAppMessagingConfig } from './InAppMessaging/types';
-import { PushNotificationConfig } from './PushNotification/types';
+import { InAppMessagingConfig } from './inAppMessaging/types';
+import { PushNotificationConfig } from './pushNotifications/types';
 
 export type NotificationsCategory = 'Notifications';
 

package/lib/InAppMessaging/InAppMessaging.d.ts

@@ -1,57 +0,0 @@
-import { EventListener } from '../common';
-import { UserInfo } from '../types';
-import { InAppMessage, InAppMessageInteractionEvent, InAppMessagingInterface, InAppMessagingConfig, InAppMessageConflictHandler, InAppMessagingEvent, InAppMessagingProvider, NotificationsSubCategory, OnMessageInteractionEventHandler } from './types';
-export default class InAppMessaging implements InAppMessagingInterface {
-    private config;
-    private conflictHandler;
-    private listeningForAnalyticEvents;
-    private pluggables;
-    private storageSynced;
-    constructor();
-    /**
-     * Configure InAppMessaging
-     * @param {Object} config - InAppMessaging configuration object
-     */
-    configure: ({ listenForAnalyticsEvents, ...config }?: InAppMessagingConfig) => InAppMessagingConfig;
-    /**
-     * Get the name of this module
-     * @returns {string} name of this module
-     */
-    getModuleName(): NotificationsSubCategory;
-    /**
-     * Get a plugin from added plugins
-     * @param {string} providerName - the name of the plugin to get
-     */
-    getPluggable: (providerName: string) => InAppMessagingProvider;
-    /**
-     * Add plugin into InAppMessaging
-     * @param {InAppMessagingProvider} pluggable - an instance of the plugin
-     */
-    addPluggable: (pluggable: InAppMessagingProvider) => void;
-    /**
-     * Remove a plugin from added plugins
-     * @param {string} providerName - the name of the plugin to remove
-     */
-    removePluggable: (providerName: string) => void;
-    /**
-     * Get the map resources that are currently available through the provider
-     * @param {string} provider
-     * @returns - Array of available map resources
-     */
-    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;
-    private analyticsListener;
-    private syncStorage;
-    private getMessages;
-    private setMessages;
-    private removeMessages;
-    private defaultConflictHandler;
-}