@aws-amplify/rtn-push-notification 1.1.8-api-v6-models.b3abc9b.0 → 1.2.0

package/lib-esm/utils/normalizeNativePermissionStatus.js

@@ -0,0 +1,19 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * @internal
+ */
+export const normalizeNativePermissionStatus = (nativeStatus) => {
+    switch (nativeStatus) {
+        case 'ShouldRequest':
+            return 'shouldRequest';
+        case 'NotDetermined':
+        case 'ShouldExplainThenRequest':
+            return 'shouldExplainThenRequest';
+        case 'Authorized':
+        case 'Granted':
+            return 'granted';
+        case 'Denied':
+            return 'denied';
+    }
+};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@aws-amplify/rtn-push-notification",
-	"version": "1.1.8-api-v6-models.b3abc9b.0+b3abc9b",
+	"version": "1.2.0",
 	"description": "React Native module for aws-amplify push notifications",
 	"main": "./lib/index.js",
 	"module": "./lib-esm/index.js",
@@ -10,18 +10,22 @@
 		"access": "public"
 	},
 	"scripts": {
-		"test": "tslint 'src/**/*.ts'",
+		"test": "npm run lint && jest -w 1 --coverage",
 		"test:android": "./android/gradlew test -p ./android",
 		"build-with-test": "npm run clean && npm test && tsc && webpack",
-		"build:cjs": "node ./build es5 && webpack && webpack --config ./webpack.config.dev.js",
-		"build:esm": "node ./build es6",
-		"build:cjs:watch": "node ./build es5 --watch",
-		"build:esm:watch": "node ./build es6 --watch",
+		"build:cjs": "rimraf lib && tsc -m commonjs --outDir lib && webpack && webpack --config ./webpack.config.dev.js",
+		"build:esm": "rimraf lib-esm && tsc -m esnext --outDir lib-esm",
+		"build:cjs:watch": "rimraf lib && tsc -m commonjs --outDir lib --watch",
+		"build:esm:watch": "rimraf lib-esm && tsc -m esnext --outDir lib-esm --watch",
 		"build": "npm run clean && npm run build:esm && npm run build:cjs",
 		"clean": "rimraf lib-esm lib dist",
 		"format": "echo \"Not implemented\"",
 		"lint": "tslint 'src/**/*.ts' && npm run ts-coverage",
-		"ts-coverage": "typescript-coverage-report -p ./tsconfig.build.json -t 88.21"
+		"ts-coverage": "typescript-coverage-report -p ./tsconfig.json -t 99"
+	},
+	"devDependencies": {
+		"@types/react-native": "0.70.0",
+		"typescript": "5.0.2"
 	},
 	"react-native": {
 		"./lib/index": "./lib-esm/index.js"
@@ -44,5 +48,46 @@
 		"lib-esm",
 		"src"
 	],
-	"gitHead": "b3abc9b75f6f1353f4c2fbc10cd3369be498e9fc"
+	"jest": {
+		"globals": {
+			"ts-jest": {
+				"diagnostics": false,
+				"tsConfig": {
+					"allowJs": true,
+					"noEmitOnError": false
+				}
+			}
+		},
+		"transform": {
+			"^.+\\.(js|jsx|ts|tsx)$": "ts-jest"
+		},
+		"testPathIgnorePatterns": [
+			"/testUtils/"
+		],
+		"testRegex": "(/__tests__/.*|\\.(test|spec))\\.(tsx?|jsx?)$",
+		"moduleFileExtensions": [
+			"ts",
+			"tsx",
+			"js",
+			"json",
+			"jsx"
+		],
+		"testEnvironment": "jsdom",
+		"testURL": "http://localhost/",
+		"coverageThreshold": {
+			"global": {
+				"branches": 0,
+				"functions": 0,
+				"lines": 0,
+				"statements": 0
+			}
+		},
+		"coveragePathIgnorePatterns": [
+			"node_modules",
+			"dist",
+			"lib",
+			"lib-esm"
+		]
+	},
+	"gitHead": "d505105326d7f6214f6bd1e06eb20be3a3651377"
 }

package/src/apis/addMessageEventListener.ts

@@ -0,0 +1,21 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { EmitterSubscription } from 'react-native';
+import { nativeEventEmitter } from '../nativeModule';
+import { NativeMessage, PushNotificationMessage } from '../types';
+import { normalizeNativeMessage } from '../utils';
+
+export const addMessageEventListener = (
+	event: string,
+	listener: (
+		message: PushNotificationMessage | null,
+		completionHandlerId?: string
+	) => void
+): EmitterSubscription =>
+	nativeEventEmitter.addListener(event, (nativeMessage: NativeMessage) => {
+		listener(
+			normalizeNativeMessage(nativeMessage),
+			nativeMessage.completionHandlerId
+		);
+	});

package/src/apis/addTokenEventListener.ts

@@ -0,0 +1,14 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { EmitterSubscription } from 'react-native';
+import { nativeEventEmitter } from '../nativeModule';
+import { TokenPayload } from '../types';
+
+export const addTokenEventListener = (
+	event: string,
+	listener: (token: string) => void
+): EmitterSubscription =>
+	nativeEventEmitter.addListener(event, ({ token }: TokenPayload) => {
+		listener(token);
+	});

package/src/apis/completeNotification.ts

@@ -0,0 +1,7 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { nativeModule } from '../nativeModule';
+
+export const completeNotification = (completionHandlerId: string): void =>
+	nativeModule.completeNotification?.(completionHandlerId);

package/src/apis/getBadgeCount.ts

@@ -0,0 +1,7 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { nativeModule } from '../nativeModule';
+
+export const getBadgeCount = (): void | Promise<number | null> =>
+	nativeModule.getBadgeCount?.();

package/src/apis/getConstants.ts

@@ -0,0 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { nativeModule } from '../nativeModule';
+
+export const getConstants = () => nativeModule.getConstants();

package/src/apis/getLaunchNotification.ts

@@ -0,0 +1,12 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { nativeModule } from '../nativeModule';
+import { PushNotificationMessage } from '../types';
+import { normalizeNativeMessage } from '../utils';
+
+export const getLaunchNotification =
+	async (): Promise<PushNotificationMessage | null> =>
+		normalizeNativeMessage(
+			(await nativeModule.getLaunchNotification()) ?? undefined
+		);

package/src/apis/getPermissionStatus.ts

@@ -0,0 +1,10 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { nativeModule } from '../nativeModule';
+import { PushNotificationPermissionStatus } from '../types';
+import { normalizeNativePermissionStatus } from '../utils';
+
+export const getPermissionStatus =
+	async (): Promise<PushNotificationPermissionStatus> =>
+		normalizeNativePermissionStatus(await nativeModule.getPermissionStatus());

package/src/apis/index.ts

@@ -0,0 +1,13 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { addMessageEventListener } from './addMessageEventListener';
+export { addTokenEventListener } from './addTokenEventListener';
+export { completeNotification } from './completeNotification';
+export { getBadgeCount } from './getBadgeCount';
+export { getConstants } from './getConstants';
+export { getLaunchNotification } from './getLaunchNotification';
+export { getPermissionStatus } from './getPermissionStatus';
+export { registerHeadlessTask } from './registerHeadlessTask';
+export { requestPermissions } from './requestPermissions';
+export { setBadgeCount } from './setBadgeCount';

package/src/apis/registerHeadlessTask.ts

@@ -0,0 +1,21 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { AppRegistry } from 'react-native';
+import { getConstants } from './getConstants';
+import { NativeMessage, PushNotificationMessage } from '../types';
+import { normalizeNativeMessage } from '../utils';
+
+export const registerHeadlessTask = (
+	task: (message: PushNotificationMessage | null) => Promise<void>
+): void => {
+	const { NativeHeadlessTaskKey } = getConstants();
+	if (NativeHeadlessTaskKey) {
+		AppRegistry.registerHeadlessTask(
+			NativeHeadlessTaskKey,
+			() => async (nativeMessage: NativeMessage) => {
+				await task(normalizeNativeMessage(nativeMessage));
+			}
+		);
+	}
+};

package/src/apis/requestPermissions.ts

@@ -0,0 +1,18 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { nativeModule } from '../nativeModule';
+import { PushNotificationPermissions } from '../types';
+
+export const requestPermissions = async (
+	{ alert = true, badge = true, sound = true }: PushNotificationPermissions = {
+		alert: true,
+		badge: true,
+		sound: true,
+	}
+): Promise<boolean> =>
+	nativeModule.requestPermissions({
+		alert,
+		badge,
+		sound,
+	});

package/src/apis/setBadgeCount.ts

@@ -0,0 +1,7 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { nativeModule } from '../nativeModule';
+
+export const setBadgeCount = (count: number): void =>
+	nativeModule.setBadgeCount?.(count);

package/src/constants.ts

@@ -0,0 +1,11 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { Platform } from 'react-native';
+
+// General
+export const PACKAGE_NAME = '@aws-amplify/rtn-push-notification';
+export const LINKING_ERROR =
+	`The ${PACKAGE_NAME} package doesn't seem to be linked. Make sure: \n\n` +
+	Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
+	'- You rebuilt the app after installing the package\n' +
+	'- You are not using Expo Go\n';

package/src/index.ts

@@ -1,10 +1,36 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { NativeModules } from 'react-native';
-import { PushNotificationNativeModule } from './types';
-export { PushNotificationNativeModule } from './types';
-export const {
-	AmplifyRTNPushNotification,
-}: { AmplifyRTNPushNotification?: PushNotificationNativeModule } =
-	NativeModules;
+import {
+	addMessageEventListener,
+	addTokenEventListener,
+	completeNotification,
+	getBadgeCount,
+	getConstants,
+	getLaunchNotification,
+	getPermissionStatus,
+	registerHeadlessTask,
+	requestPermissions,
+	setBadgeCount,
+} from './apis';
+export {
+	PushNotificationMessage,
+	PushNotificationPermissionStatus,
+	PushNotificationPermissions,
+} from './types';
+
+const module = {
+	addMessageEventListener,
+	addTokenEventListener,
+	completeNotification,
+	getBadgeCount,
+	getConstants,
+	getLaunchNotification,
+	getPermissionStatus,
+	registerHeadlessTask,
+	requestPermissions,
+	setBadgeCount,
+};
+
+export type PushNotificationModule = typeof module;
+export { module };

package/src/nativeModule.ts

@@ -0,0 +1,20 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { NativeModules, NativeEventEmitter } from 'react-native';
+import { LINKING_ERROR } from './constants';
+import { PushNotificationNativeModule } from './types';
+
+export const nativeModule: PushNotificationNativeModule =
+	NativeModules.AmplifyRTNPushNotification
+		? NativeModules.AmplifyRTNPushNotification
+		: new Proxy(
+				{},
+				{
+					get() {
+						throw new Error(LINKING_ERROR);
+					},
+				}
+		  );
+
+export const nativeEventEmitter = new NativeEventEmitter(nativeModule);

package/src/types/index.ts

@@ -0,0 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export * from './module';
+export * from './native';

package/src/types/module.ts

@@ -0,0 +1,43 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * Types here are duplicated to the push notificaiton category within Amplify 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 Amplify library and vice-versa!
+ */
+
+export interface PushNotificationPermissions
+	extends Partial<Record<string, boolean>> {
+	alert?: boolean;
+	badge?: boolean;
+	sound?: boolean;
+}
+
+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';
+
+interface ApnsPlatformOptions {
+	subtitle?: string;
+}
+
+interface FcmPlatformOptions {
+	channelId: string;
+	messageId: string;
+	senderId: string;
+	sendTime: Date;
+}

package/src/types/native.ts

@@ -0,0 +1,92 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { NativeModule } from 'react-native';
+import { PushNotificationMessage, PushNotificationPermissions } from './module';
+
+export interface PushNotificationNativeModule extends NativeModule {
+	completeNotification?: (completionHandlerId: string) => void;
+	getConstants: () => {
+		NativeEvent: {
+			BACKGROUND_MESSAGE_RECEIVED?: string;
+			FOREGROUND_MESSAGE_RECEIVED: string;
+			LAUNCH_NOTIFICATION_OPENED: string;
+			NOTIFICATION_OPENED: string;
+			TOKEN_RECEIVED: string;
+		};
+		NativeHeadlessTaskKey?: string;
+	};
+	getLaunchNotification: () => Promise<NativeMessage | null>;
+	getBadgeCount?: () => Promise<number>;
+	setBadgeCount?: (count: number) => void;
+	getPermissionStatus: () => Promise<NativePermissionStatus>;
+	requestPermissions: (
+		permissions: PushNotificationPermissions
+	) => Promise<boolean>;
+}
+
+export type NativeAction = {
+	deeplink?: string;
+	url?: string;
+};
+
+export type NativeMessage = (ApnsMessage | FcmMessage) & {
+	token?: never;
+};
+
+export type NativePermissionStatus =
+	| AndroidPermissionStatus
+	| IosPermissionStatus;
+
+export interface NormalizedValues {
+	body?: string;
+	imageUrl?: string;
+	title?: string;
+	action?: Pick<PushNotificationMessage, 'goToUrl' | 'deeplinkUrl'>;
+	options?: Pick<PushNotificationMessage, 'apnsOptions' | 'fcmOptions'>;
+	data?: Record<string, unknown>;
+}
+
+// iOS
+export type ApnsMessage = {
+	aps: {
+		alert?: {
+			body?: string;
+			title?: string;
+			subtitle?: string;
+		};
+	};
+	data?: {
+		pinpoint?: NativeAction;
+		'media-url'?: string;
+	};
+	rawData?: never;
+	completionHandlerId?: string;
+};
+
+export type IosPermissionStatus = 'NotDetermined' | 'Authorized' | 'Denied';
+
+// Android
+export type FcmMessage = {
+	action?: NativeAction;
+	aps?: never;
+	body?: string;
+	imageUrl?: string;
+	rawData?: Record<string, unknown>;
+	title?: string;
+	channelId?: string;
+	messageId?: string;
+	senderId?: string;
+	sendTime?: number;
+	completionHandlerId?: never;
+};
+
+export type AndroidPermissionStatus =
+	| 'ShouldRequest'
+	| 'ShouldExplainThenRequest'
+	| 'Granted'
+	| 'Denied';
+
+export type TokenPayload = {
+	token: string;
+};

package/src/utils/index.ts

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

package/src/utils/normalizeNativeMessage.ts

@@ -0,0 +1,103 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { isEmpty } from 'lodash';
+import {
+	ApnsMessage,
+	FcmMessage,
+	NativeAction,
+	NativeMessage,
+	NormalizedValues,
+	PushNotificationMessage,
+} from '../types';
+
+/**
+ * @internal
+ */
+export const normalizeNativeMessage = (
+	nativeMessage?: NativeMessage
+): PushNotificationMessage | null => {
+	let normalized: NormalizedValues;
+	if (isApnsMessage(nativeMessage)) {
+		normalized = normalizeApnsMessage(nativeMessage);
+	} else if (isFcmMessage(nativeMessage)) {
+		normalized = normalizeFcmMessage(nativeMessage);
+	} else {
+		return null;
+	}
+	const { body, imageUrl, title, action, options, data } = normalized;
+	return {
+		body,
+		data,
+		imageUrl,
+		title,
+		...action,
+		...options,
+	};
+};
+
+const normalizeApnsMessage = (apnsMessage: ApnsMessage): NormalizedValues => {
+	const { aps, data } = apnsMessage;
+	const { body, title } = aps.alert ?? {};
+	const action = getApnsAction(data?.pinpoint) ?? {};
+	const imageUrl = data?.['media-url'];
+	const options = getApnsOptions(apnsMessage);
+	return { body, imageUrl, title, action, options, data };
+};
+
+const normalizeFcmMessage = (fcmMessage: FcmMessage): NormalizedValues => {
+	const { body, imageUrl, rawData: data, title } = fcmMessage;
+	const action = getFcmAction(fcmMessage.action) ?? {};
+	const options = getFcmOptions(fcmMessage);
+	return { body, imageUrl, title, action, options, data };
+};
+
+const getApnsAction = (
+	action?: NativeAction
+): Pick<PushNotificationMessage, 'deeplinkUrl'> | undefined => {
+	if (action?.deeplink) {
+		return { deeplinkUrl: action.deeplink };
+	}
+};
+
+const getFcmAction = (
+	action?: NativeAction
+): Pick<PushNotificationMessage, 'goToUrl' | 'deeplinkUrl'> | undefined => {
+	if (action?.url) {
+		return { goToUrl: action.url };
+	}
+	if (action?.deeplink) {
+		return { deeplinkUrl: action.deeplink };
+	}
+};
+
+const getApnsOptions = ({
+	aps,
+}: ApnsMessage): Pick<PushNotificationMessage, 'apnsOptions'> => {
+	const { subtitle } = aps.alert ?? {};
+	const apnsOptions = { ...(subtitle && { subtitle }) };
+	return { ...(!isEmpty(apnsOptions) && { apnsOptions }) };
+};
+
+const getFcmOptions = ({
+	channelId = '',
+	messageId = '',
+	senderId = '',
+	sendTime = new Date().getTime(),
+}: FcmMessage): Pick<PushNotificationMessage, 'fcmOptions'> => {
+	const fcmOptions = {
+		channelId,
+		messageId,
+		senderId,
+		sendTime: new Date(sendTime),
+	};
+	return { ...(!isEmpty(fcmOptions) && { fcmOptions }) };
+};
+
+const isApnsMessage = (
+	nativeMessage?: NativeMessage
+): nativeMessage is ApnsMessage => !!nativeMessage?.aps;
+
+const isFcmMessage = (
+	nativeMessage?: NativeMessage
+): nativeMessage is FcmMessage => !!nativeMessage?.rawData;

package/src/utils/normalizeNativePermissionStatus.ts

@@ -0,0 +1,27 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	NativePermissionStatus,
+	PushNotificationPermissionStatus,
+} from '../types';
+
+/**
+ * @internal
+ */
+export const normalizeNativePermissionStatus = (
+	nativeStatus: NativePermissionStatus
+): PushNotificationPermissionStatus => {
+	switch (nativeStatus) {
+		case 'ShouldRequest':
+			return 'shouldRequest';
+		case 'NotDetermined':
+		case 'ShouldExplainThenRequest':
+			return 'shouldExplainThenRequest';
+		case 'Authorized':
+		case 'Granted':
+			return 'granted';
+		case 'Denied':
+			return 'denied';
+	}
+};

package/lib/.tsbuildinfo

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

package/lib/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,qEAAqE;AACrE,sCAAsC;;AAEtC,6CAA6C;AAI5C,QAAA,0BAA0B,GAE1B,4BAAa,4BAAC"}

package/lib/types.d.ts

@@ -1,18 +0,0 @@
-export interface PushNotificationNativeModule {
-    completeNotification?: (completionHandlerId: string) => void;
-    getConstants: () => {
-        NativeEvent: {
-            BACKGROUND_MESSAGE_RECEIVED?: string;
-            FOREGROUND_MESSAGE_RECEIVED: string;
-            LAUNCH_NOTIFICATION_OPENED: string;
-            NOTIFICATION_OPENED: string;
-            TOKEN_RECEIVED: string;
-        };
-        NativeHeadlessTaskKey?: string;
-    };
-    getLaunchNotification: () => Promise<Record<string, string>>;
-    getBadgeCount: () => Promise<number>;
-    setBadgeCount: (count: number) => void;
-    getPermissionStatus: () => Promise<string>;
-    requestPermissions: (permissions: Record<string, boolean>) => Promise<boolean>;
-}

package/lib/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA,qEAAqE;AACrE,sCAAsC"}

package/lib-esm/.tsbuildinfo

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

package/lib-esm/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC;AAEtC,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAG7C,MAAM,CACL,IAAA,qEAA0B,CAEZ"}