Merge pull request #32180 from fabioh8010/ts/lib/PushNotification

[TS migration] Migrate 'PushNotification' lib to TypeScript

__mocks__/@ua/react-native-airship.js

@@ -31,7 +31,7 @@ const Airship = {
     },
     contact: {
         identify: jest.fn(),
-        getNamedUserId: jest.fn(),
+        getNamedUserId: () => Promise.resolve(undefined),
         reset: jest.fn(),
     },
 };

src/libs/Notification/PushNotification/ForegroundNotifications/index.android.js → src/libs/Notification/PushNotification/ForegroundNotifications/index.android.ts

@@ -1,5 +1,6 @@
 import Airship from '@ua/react-native-airship';
 import shouldShowPushNotification from '@libs/Notification/PushNotification/shouldShowPushNotification';
+import ForegroundNotificationsModule from './types';
 
 function configureForegroundNotifications() {
     Airship.push.android.setForegroundDisplayPredicate((pushPayload) => Promise.resolve(shouldShowPushNotification(pushPayload)));
@@ -9,7 +10,9 @@ function disableForegroundNotifications() {
     Airship.push.android.setForegroundDisplayPredicate(() => Promise.resolve(false));
 }
 
-export default {
+const ForegroundNotifications: ForegroundNotificationsModule = {
     configureForegroundNotifications,
     disableForegroundNotifications,
 };
+
+export default ForegroundNotifications;

src/libs/Notification/PushNotification/ForegroundNotifications/index.ios.js → src/libs/Notification/PushNotification/ForegroundNotifications/index.ios.ts

@@ -1,5 +1,6 @@
 import Airship, {iOS} from '@ua/react-native-airship';
 import shouldShowPushNotification from '@libs/Notification/PushNotification/shouldShowPushNotification';
+import ForegroundNotificationsModule from './types';
 
 function configureForegroundNotifications() {
     // Set our default iOS foreground presentation to be loud with a banner
@@ -20,7 +21,9 @@ function disableForegroundNotifications() {
     Airship.push.iOS.setForegroundPresentationOptionsCallback(() => Promise.resolve([]));
 }
 
-export default {
+const ForegroundNotifications: ForegroundNotificationsModule = {
     configureForegroundNotifications,
     disableForegroundNotifications,
 };
+
+export default ForegroundNotifications;

src/libs/Notification/PushNotification/ForegroundNotifications/index.js → src/libs/Notification/PushNotification/ForegroundNotifications/index.ts

@@ -1,7 +1,11 @@
+import ForegroundNotificationsModule from './types';
+
 /**
  * Configures notification handling while in the foreground on iOS and Android. This is a no-op on other platforms.
  */
-export default {
+const ForegroundNotifications: ForegroundNotificationsModule = {
     configureForegroundNotifications: () => {},
     disableForegroundNotifications: () => {},
 };
+
+export default ForegroundNotifications;

src/libs/Notification/PushNotification/ForegroundNotifications/types.ts

@@ -0,0 +1,6 @@
+type ForegroundNotificationsModule = {
+    configureForegroundNotifications: () => void;
+    disableForegroundNotifications: () => void;
+};
+
+export default ForegroundNotificationsModule;

src/libs/Notification/PushNotification/NotificationType.ts

@@ -0,0 +1,28 @@
+import {OnyxServerUpdate} from '@src/types/onyx/OnyxUpdatesFromServer';
+
+const NotificationType = {
+    REPORT_COMMENT: 'reportComment',
+} as const;
+
+type NotificationDataMap = {
+    [NotificationType.REPORT_COMMENT]: ReportCommentNotificationData;
+};
+
+type NotificationData = ReportCommentNotificationData;
+
+type ReportCommentNotificationData = {
+    title: string;
+    type: typeof NotificationType.REPORT_COMMENT;
+    reportID: number;
+    reportActionID: string;
+    shouldScrollToLastUnread?: boolean;
+    roomName?: string;
+    onyxData?: OnyxServerUpdate[];
+};
+
+/**
+ * See https://github.com/Expensify/Web-Expensify/blob/main/lib/MobilePushNotifications.php for the various
+ * types of push notifications sent by our API.
+ */
+export default NotificationType;
+export type {NotificationDataMap, NotificationData, ReportCommentNotificationData};

src/libs/Notification/PushNotification/backgroundRefresh/index.android.js → src/libs/Notification/PushNotification/backgroundRefresh/index.android.ts

@@ -4,8 +4,9 @@ import Visibility from '@libs/Visibility';
 import * as App from '@userActions/App';
 import CONST from '@src/CONST';
 import ONYXKEYS from '@src/ONYXKEYS';
+import BackgroundRefresh from './types';
 
-function getLastOnyxUpdateID() {
+function getLastOnyxUpdateID(): Promise<number | null> {
     return new Promise((resolve) => {
         const connectionID = Onyx.connect({
             key: ONYXKEYS.ONYX_UPDATES_LAST_UPDATE_ID_APPLIED_TO_CLIENT,
@@ -23,7 +24,7 @@ function getLastOnyxUpdateID() {
  * We use this to refresh the app in the background after receiving a push notification (native only). Since the full app
  * wakes on iOS and by extension runs reconnectApp already, this is a no-op on everything but Android.
  */
-export default function backgroundRefresh() {
+const backgroundRefresh: BackgroundRefresh = () => {
     if (Visibility.isVisible()) {
         return;
     }
@@ -38,9 +39,11 @@ export default function backgroundRefresh() {
              * See more here: https://reactnative.dev/docs/headless-js-android
              */
             App.confirmReadyToOpenApp();
-            App.reconnectApp(lastUpdateIDAppliedToClient);
+            App.reconnectApp(lastUpdateIDAppliedToClient ?? undefined);
         })
         .catch((error) => {
             Log.alert(`${CONST.ERROR.ENSURE_BUGBOT} [PushNotification] backgroundRefresh failed. This should never happen.`, {error});
         });
-}
+};
+
+export default backgroundRefresh;

src/libs/Notification/PushNotification/backgroundRefresh/index.js → src/libs/Notification/PushNotification/backgroundRefresh/index.ts

@@ -1,7 +1,11 @@
+import BackgroundRefresh from './types';
+
 /**
  * Runs our reconnectApp action if the app is in the background.
  *
  * We use this to refresh the app in the background after receiving a push notification (native only). Since the full app
  * wakes on iOS and by extension runs reconnectApp already, this is a no-op on everything but Android.
  */
-export default function backgroundRefresh() {}
+const backgroundRefresh: BackgroundRefresh = () => {};
+
+export default backgroundRefresh;

src/libs/Notification/PushNotification/backgroundRefresh/types.ts

@@ -0,0 +1,3 @@
+type BackgroundRefresh = () => void;
+
+export default BackgroundRefresh;