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

package/src/pushNotifications/providers/pinpoint/utils/getChannelType.ts

@@ -0,0 +1,25 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { PlatformNotSupportedError } from '@aws-amplify/core/internals/utils';
+import { getOperatingSystem } from '@aws-amplify/react-native';
+import { ChannelType } from '../types';
+
+const operatingSystem = getOperatingSystem();
+const isAndroid = operatingSystem === 'android';
+const isIos = operatingSystem === 'ios';
+
+/**
+ * @internal
+ */
+export const getChannelType = (): ChannelType => {
+	if (isAndroid) {
+		// FCM was previously known as GCM and continues to be the channel type in Pinpoint
+		return 'GCM';
+	}
+	if (isIos) {
+		// If building in debug mode, use the APNs sandbox
+		return __DEV__ ? 'APNS_SANDBOX' : 'APNS';
+	}
+	throw new PlatformNotSupportedError();
+};

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

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

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

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

package/src/{InAppMessaging/Providers/index.ts → pushNotifications/types/errors.ts}

@@ -1,4 +1,6 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-export { default as AWSPinpointProvider } from './AWSPinpointProvider';
+export enum PushNotificationErrorCode {
+	NotInitialized = 'NotInitialized',
+}

package/src/pushNotifications/types/index.ts

@@ -0,0 +1,9 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export * from './errors';
+export * from './inputs';
+export * from './module';
+export * from './options';
+export * from './outputs';
+export * from './pushNotifications';

package/src/pushNotifications/types/inputs.ts

@@ -0,0 +1,45 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { UserProfile } from '@aws-amplify/core';
+import { PushNotificationServiceOptions } from './options';
+import { PushNotificationPermissions } from './module';
+import {
+	OnPushNotificationMessageHandler,
+	OnTokenReceivedHandler,
+} from './pushNotifications';
+
+export type PushNotificationIdentifyUserInput<
+	ServiceOptions extends PushNotificationServiceOptions = PushNotificationServiceOptions
+> = {
+	/**
+	 * 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;
+};
+
+export type PushNotificationRequestPermissionsInput =
+	PushNotificationPermissions;
+
+export type PushNotificationSetBadgeCountInput = number;
+
+export type PushNotificationOnNotificationOpenedInput =
+	OnPushNotificationMessageHandler;
+
+export type PushNotificationOnNotificationReceivedInBackgroundInput =
+	OnPushNotificationMessageHandler;
+
+export type PushNotificationOnNotificationReceivedInForegroundInput =
+	OnPushNotificationMessageHandler;
+
+export type PushNotificationOnTokenReceivedInput = OnTokenReceivedHandler;

package/src/pushNotifications/types/module.ts

@@ -0,0 +1,42 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * Types here are duplicated from `rtn-push-notifications` as it is not possible to share a source of truth
+ * with a package that may conditionally not exist for developers not using push notifications. Modifications
+ * made to these types should be reflected in the native module package and vice-versa!
+ */
+interface ApnsPlatformOptions {
+	subtitle?: string;
+}
+
+interface FcmPlatformOptions {
+	channelId: string;
+	messageId: string;
+	senderId: string;
+	sendTime: Date;
+}
+
+export interface PushNotificationMessage {
+	title?: string;
+	body?: string;
+	imageUrl?: string;
+	deeplinkUrl?: string;
+	goToUrl?: string;
+	fcmOptions?: FcmPlatformOptions;
+	apnsOptions?: ApnsPlatformOptions;
+	data?: Record<string, unknown>;
+}
+
+export type PushNotificationPermissionStatus =
+	| 'denied'
+	| 'granted'
+	| 'shouldRequest'
+	| 'shouldExplainThenRequest';
+
+export interface PushNotificationPermissions
+	extends Partial<Record<string, boolean>> {
+	alert?: boolean;
+	badge?: boolean;
+	sound?: boolean;
+}

package/src/pushNotifications/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 PushNotificationServiceOptions = Record<string, unknown>;

package/src/pushNotifications/types/outputs.ts

@@ -0,0 +1,28 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { EventListenerRemover } from '../../eventListeners';
+import {
+	PushNotificationMessage,
+	PushNotificationPermissionStatus,
+} from '../types';
+
+export type PushNotificationGetBadgeCountOutput = number | null;
+
+export type PushNotificationGetLaunchNotificationOutput =
+	PushNotificationMessage | null;
+
+export type PushNotificationGetPermissionStatusOutput =
+	PushNotificationPermissionStatus;
+
+export type PushNotificationRequestPermissionsOutput = boolean;
+
+export type PushNotificationOnNotificationOpenedOutput = EventListenerRemover;
+
+export type PushNotificationOnNotificationReceivedInBackgroundOutput =
+	EventListenerRemover;
+
+export type PushNotificationOnNotificationReceivedInForegroundOutput =
+	EventListenerRemover;
+
+export type PushNotificationOnTokenReceivedOutput = EventListenerRemover;

package/src/pushNotifications/types/pushNotifications.ts

@@ -0,0 +1,17 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { PushNotificationMessage } from './module';
+
+export type OnTokenReceivedHandler = (token: string) => void;
+
+export type OnPushNotificationMessageHandler = (
+	message: PushNotificationMessage
+) => void;
+
+export type PushNotificationEvent =
+	| 'backgroundMessageReceived'
+	| 'foregroundMessageReceived'
+	| 'launchNotificationOpened'
+	| 'notificationOpened'
+	| 'tokenReceived';

package/src/pushNotifications/utils/getPushNotificationUserAgentString.ts

@@ -0,0 +1,15 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import {
+	PushNotificationAction,
+	Category,
+	getAmplifyUserAgent,
+} from '@aws-amplify/core/internals/utils';
+
+export const getPushNotificationUserAgentString = (
+	action: PushNotificationAction
+) =>
+	getAmplifyUserAgent({
+		category: Category.PushNotification,
+		action,
+	});

package/src/pushNotifications/utils/index.ts

@@ -0,0 +1,7 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { getPushNotificationUserAgentString } from './getPushNotificationUserAgentString';
+export { initialize, isInitialized } from './initializationManager';
+export { resolveCredentials } from './resolveCredentials';
+export { getToken, setToken } from './tokenManager';

package/src/pushNotifications/utils/initializationManager.ts

@@ -0,0 +1,20 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+let initialized = false;
+
+/**
+ * Sets initialization status to true.
+ *
+ * @internal
+ */
+export const initialize = async () => {
+	initialized = true;
+};
+
+/**
+ * Returns the initialization status of push notifications.
+ *
+ * @internal
+ */
+export const isInitialized = () => initialized;

package/src/pushNotifications/utils/resolveCredentials.ts

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

package/src/pushNotifications/utils/tokenManager.ts

@@ -0,0 +1,20 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+let token: string;
+
+/**
+ * Sets token.
+ *
+ * @internal
+ */
+export const setToken = (newToken: string) => {
+	token = newToken;
+};
+
+/**
+ * Returns the current token.
+ *
+ * @internal
+ */
+export const getToken = () => token;

package/lib/.tsbuildinfo

@@ -1,3 +0,0 @@
-{
-  "version": "3.8.3"
-}

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;
-}