@office-iss/react-native-win32 0.0.0-canary.30 → 0.0.0-canary.301

package/Libraries/PushNotificationIOS/PushNotificationIOS.js

@@ -1,24 +1,76 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @format
  * @flow
+ * @format
  */
 
-'use strict';
+import type {EventSubscription} from '../vendor/emitter/EventEmitter';
 
-const NativeEventEmitter = require('../EventEmitter/NativeEventEmitter');
+import NativeEventEmitter from '../EventEmitter/NativeEventEmitter';
+import Platform from '../Utilities/Platform';
 import NativePushNotificationManagerIOS from './NativePushNotificationManagerIOS';
-const invariant = require('invariant');
+import invariant from 'invariant';
+
+export type PushNotificationPermissions = {
+  alert: boolean,
+  badge: boolean,
+  sound: boolean,
+  [key: string]: boolean | number,
+};
+
+type PresentLocalNotificationDetails = {
+  alertBody: string,
+  alertAction?: string,
+  alertTitle?: string,
+  soundName?: string,
+  category?: string,
+  userInfo?: Object,
+  applicationIconBadgeNumber?: number,
+  fireDate?: number,
+  isSilent?: boolean,
+};
+
+type ScheduleLocalNotificationDetails = {
+  ...PresentLocalNotificationDetails,
+  repeatInterval?: 'year' | 'month' | 'week' | 'day' | 'hour' | 'minute',
+};
+
+type NativePushNotificationIOSEventDefinitions = {
+  remoteNotificationReceived: [
+    {
+      notificationId: string,
+      remote: boolean,
+      ...
+    },
+  ],
+  remoteNotificationsRegistered: [
+    {
+      deviceToken?: ?string,
+      ...
+    },
+  ],
+  remoteNotificationRegistrationError: [
+    {
+      message: string,
+      code: number,
+      details: {...},
+    },
+  ],
+  localNotificationReceived: [{...}],
+};
 
-const PushNotificationEmitter = new NativeEventEmitter(
-  NativePushNotificationManagerIOS,
-);
+const PushNotificationEmitter =
+  new NativeEventEmitter<NativePushNotificationIOSEventDefinitions>(
+    // T88715063: NativeEventEmitter only used this parameter on iOS. Now it uses it on all platforms, so this code was modified automatically to preserve its behavior
+    // If you want to use the native module on other platforms, please remove this condition and test its behavior
+    Platform.OS !== 'ios' ? null : NativePushNotificationManagerIOS,
+  );
 
-const _notifHandlers = new Map();
+const _notifHandlers = new Map<string, void | EventSubscription>();
 
 const DEVICE_NOTIF_EVENT = 'remoteNotificationReceived';
 const NOTIF_REGISTER_EVENT = 'remoteNotificationsRegistered';
@@ -28,9 +80,9 @@ const DEVICE_LOCAL_NOTIF_EVENT = 'localNotificationReceived';
 export type ContentAvailable = 1 | null | void;
 
 export type FetchResult = {
-  NewData: string,
-  NoData: string,
-  ResultFailed: string,
+  NewData: 'UIBackgroundFetchResultNewData',
+  NoData: 'UIBackgroundFetchResultNoData',
+  ResultFailed: 'UIBackgroundFetchResultFailed',
   ...
 };
 
@@ -40,12 +92,16 @@ export type FetchResult = {
 export type PushNotificationEventName = $Keys<{
   /**
    * Fired when a remote notification is received. The handler will be invoked
-   * with an instance of `PushNotificationIOS`.
+   * with an instance of `PushNotificationIOS`. This will handle notifications
+   * that arrive in the foreground or were tapped to open the app from the
+   * background.
    */
   notification: string,
   /**
    * Fired when a local notification is received. The handler will be invoked
-   * with an instance of `PushNotificationIOS`.
+   * with an instance of `PushNotificationIOS`. This will handle notifications
+   * that arrive in the foreground or were tapped to open the app from the
+   * background.
    */
   localNotification: string,
   /**
@@ -55,19 +111,67 @@ export type PushNotificationEventName = $Keys<{
   register: string,
   /**
    * Fired when the user fails to register for remote notifications. Typically
-   * occurs when APNS is having issues, or the device is a simulator. The
-   * handler will be invoked with {message: string, code: number, details: any}.
+   * occurs due to APNS issues or if the device is a simulator. The handler
+   * will be invoked with {message: string, code: number, details: any}.
    */
   registrationError: string,
   ...
 }>;
 
+export interface PushNotification {
+  /**
+   * An alias for `getAlert` to get the notification's main message string
+   */
+  getMessage(): ?string | ?Object;
+
+  /**
+   * Gets the sound string from the `aps` object
+   */
+  getSound(): ?string;
+
+  /**
+   * Gets the category string from the `aps` object
+   */
+  getCategory(): ?string;
+
+  /**
+   * Gets the notification's main message from the `aps` object
+   */
+  getAlert(): ?string | ?Object;
+
+  /**
+   * Gets the content-available number from the `aps` object
+   */
+  getContentAvailable(): ContentAvailable;
+
+  /**
+   * Gets the badge count number from the `aps` object
+   */
+  getBadgeCount(): ?number;
+
+  /**
+   * Gets the data object on the notif
+   */
+  getData(): ?Object;
+
+  /**
+   * Gets the thread ID on the notif
+   */
+  getThreadID(): ?string;
+
+  /**
+   * iOS Only
+   * Signifies remote notification handling is complete
+   */
+  finish(result: string): void;
+}
+
 /**
+ * Handle notifications for your app, including scheduling and permissions.
  *
- * Handle push notifications for your app, including permission handling and
- * icon badge number.
+ * See https://reactnative.dev/docs/pushnotificationios
  *
- * See https://reactnative.dev/docs/pushnotificationios.html
+ * @deprecated Use [@react-native-community/push-notification-ios](https://www.npmjs.com/package/@react-native-community/push-notification-ios) instead
  */
 class PushNotificationIOS {
   _data: Object;
@@ -89,36 +193,58 @@ class PushNotificationIOS {
 
   /**
    * Schedules the localNotification for immediate presentation.
+   * details is an object containing:
+   * alertBody : The message displayed in the notification alert.
+   * alertAction : The "action" displayed beneath an actionable notification. Defaults to "view";
+   * soundName : The sound played when the notification is fired (optional).
+   * category : The category of this notification, required for actionable notifications (optional).
+   * userInfo : An optional object containing additional notification data.
+   * applicationIconBadgeNumber (optional) : The number to display as the app's icon badge. The default value of this property is 0, which means that no badge is displayed.
    *
-   * See https://reactnative.dev/docs/pushnotificationios.html#presentlocalnotification
+   * See https://reactnative.dev/docs/pushnotificationios#presentlocalnotification
    */
-  static presentLocalNotification(details: Object) {
+  static presentLocalNotification(
+    details: PresentLocalNotificationDetails,
+  ): void {
     invariant(
       NativePushNotificationManagerIOS,
       'PushNotificationManager is not available.',
     );
+    // $FlowFixMe[prop-missing]
     NativePushNotificationManagerIOS.presentLocalNotification(details);
   }
 
   /**
-   * Schedules the localNotification for future presentation.
+   * Schedules a local notification for future presentation.
+   *
+   * details is an object containing:
+   * fireDate : The date and time when the system should deliver the notification.
+   * alertBody : The message displayed in the notification alert.
+   * alertAction : The "action" displayed beneath an actionable notification. Defaults to "view";
+   * soundName : The sound played when the notification is fired (optional).
+   * category : The category of this notification, required for actionable notifications (optional).
+   * userInfo : An optional object containing additional notification data.
+   * applicationIconBadgeNumber (optional) : The number to display as the app's icon badge. Setting the number to 0 removes the icon badge.
    *
-   * See https://reactnative.dev/docs/pushnotificationios.html#schedulelocalnotification
+   * See https://reactnative.dev/docs/pushnotificationios#schedulelocalnotification
    */
-  static scheduleLocalNotification(details: Object) {
+  static scheduleLocalNotification(
+    details: ScheduleLocalNotificationDetails,
+  ): void {
     invariant(
       NativePushNotificationManagerIOS,
       'PushNotificationManager is not available.',
     );
+    // $FlowFixMe[prop-missing]
     NativePushNotificationManagerIOS.scheduleLocalNotification(details);
   }
 
   /**
-   * Cancels all scheduled localNotifications.
+   * Cancels all scheduled local notifications.
    *
-   * See https://reactnative.dev/docs/pushnotificationios.html#cancelalllocalnotifications
+   * See https://reactnative.dev/docs/pushnotificationios#cancelalllocalnotifications
    */
-  static cancelAllLocalNotifications() {
+  static cancelAllLocalNotifications(): void {
     invariant(
       NativePushNotificationManagerIOS,
       'PushNotificationManager is not available.',
@@ -127,9 +253,9 @@ class PushNotificationIOS {
   }
 
   /**
-   * Remove all delivered notifications from Notification Center.
+   * Removes all delivered notifications from Notification Center.
    *
-   * See https://reactnative.dev/docs/pushnotificationios.html#removealldeliverednotifications
+   * See https://reactnative.dev/docs/pushnotificationios#removealldeliverednotifications
    */
   static removeAllDeliveredNotifications(): void {
     invariant(
@@ -140,9 +266,10 @@ class PushNotificationIOS {
   }
 
   /**
-   * Provides you with a list of the app’s notifications that are still displayed in Notification Center.
+   * Provides a list of the app’s notifications that are currently displayed
+   * in Notification Center.
    *
-   * See https://reactnative.dev/docs/pushnotificationios.html#getdeliverednotifications
+   * See https://reactnative.dev/docs/pushnotificationios#getdeliverednotifications
    */
   static getDeliveredNotifications(
     callback: (notifications: Array<Object>) => void,
@@ -155,9 +282,9 @@ class PushNotificationIOS {
   }
 
   /**
-   * Removes the specified notifications from Notification Center
+   * Removes the specified notifications from Notification Center.
    *
-   * See https://reactnative.dev/docs/pushnotificationios.html#removedeliverednotifications
+   * See https://reactnative.dev/docs/pushnotificationios#removedeliverednotifications
    */
   static removeDeliveredNotifications(identifiers: Array<string>): void {
     invariant(
@@ -168,11 +295,11 @@ class PushNotificationIOS {
   }
 
   /**
-   * Sets the badge number for the app icon on the home screen.
+   * Sets the badge number for the app icon on the Home Screen.
    *
-   * See https://reactnative.dev/docs/pushnotificationios.html#setapplicationiconbadgenumber
+   * See https://reactnative.dev/docs/pushnotificationios#setapplicationiconbadgenumber
    */
-  static setApplicationIconBadgeNumber(number: number) {
+  static setApplicationIconBadgeNumber(number: number): void {
     invariant(
       NativePushNotificationManagerIOS,
       'PushNotificationManager is not available.',
@@ -181,11 +308,11 @@ class PushNotificationIOS {
   }
 
   /**
-   * Gets the current badge number for the app icon on the home screen.
+   * Gets the current badge number for the app icon on the Home Screen.
    *
-   * See https://reactnative.dev/docs/pushnotificationios.html#getapplicationiconbadgenumber
+   * See https://reactnative.dev/docs/pushnotificationios#getapplicationiconbadgenumber
    */
-  static getApplicationIconBadgeNumber(callback: Function) {
+  static getApplicationIconBadgeNumber(callback: Function): void {
     invariant(
       NativePushNotificationManagerIOS,
       'PushNotificationManager is not available.',
@@ -194,11 +321,12 @@ class PushNotificationIOS {
   }
 
   /**
-   * Cancel local notifications.
+   * Cancels any scheduled local notifications which match the fields in the
+   * provided `userInfo`.
    *
-   * See https://reactnative.dev/docs/pushnotificationios.html#cancellocalnotification
+   * See https://reactnative.dev/docs/pushnotificationios#cancellocalnotification
    */
-  static cancelLocalNotifications(userInfo: Object) {
+  static cancelLocalNotifications(userInfo: Object): void {
     invariant(
       NativePushNotificationManagerIOS,
       'PushNotificationManager is not available.',
@@ -207,11 +335,11 @@ class PushNotificationIOS {
   }
 
   /**
-   * Gets the local notifications that are currently scheduled.
+   * Gets the list of local notifications that are currently scheduled.
    *
-   * See https://reactnative.dev/docs/pushnotificationios.html#getscheduledlocalnotifications
+   * See https://reactnative.dev/docs/pushnotificationios#getscheduledlocalnotifications
    */
-  static getScheduledLocalNotifications(callback: Function) {
+  static getScheduledLocalNotifications(callback: Function): void {
     invariant(
       NativePushNotificationManagerIOS,
       'PushNotificationManager is not available.',
@@ -220,12 +348,15 @@ class PushNotificationIOS {
   }
 
   /**
-   * Attaches a listener to remote or local notification events while the app
-   * is running in the foreground or the background.
+   * Attaches a listener to notification events including local notifications,
+   * remote notifications, and notification registration results.
    *
-   * See https://reactnative.dev/docs/pushnotificationios.html#addeventlistener
+   * See https://reactnative.dev/docs/pushnotificationios#addeventlistener
    */
-  static addEventListener(type: PushNotificationEventName, handler: Function) {
+  static addEventListener(
+    type: PushNotificationEventName,
+    handler: Function,
+  ): void {
     invariant(
       type === 'notification' ||
         type === 'register' ||
@@ -270,12 +401,9 @@ class PushNotificationIOS {
    * Removes the event listener. Do this in `componentWillUnmount` to prevent
    * memory leaks.
    *
-   * See https://reactnative.dev/docs/pushnotificationios.html#removeeventlistener
+   * See https://reactnative.dev/docs/pushnotificationios#removeeventlistener
    */
-  static removeEventListener(
-    type: PushNotificationEventName,
-    handler: Function,
-  ) {
+  static removeEventListener(type: PushNotificationEventName): void {
     invariant(
       type === 'notification' ||
         type === 'register' ||
@@ -292,19 +420,15 @@ class PushNotificationIOS {
   }
 
   /**
-   * Requests notification permissions from iOS, prompting the user's
+   * Requests notification permissions from iOS, prompting the user with a
    * dialog box. By default, it will request all notification permissions, but
-   * a subset of these can be requested by passing a map of requested
-   * permissions.
+   * you can optionally specify which permissions to request.
    *
-   * See https://reactnative.dev/docs/pushnotificationios.html#requestpermissions
+   * See https://reactnative.dev/docs/pushnotificationios#requestpermissions
    */
-  static requestPermissions(permissions?: {
-    alert?: boolean,
-    badge?: boolean,
-    sound?: boolean,
-    ...
-  }): Promise<{
+  static requestPermissions(
+    permissions?: PushNotificationPermissions,
+  ): Promise<{
     alert: boolean,
     badge: boolean,
     sound: boolean,
@@ -332,11 +456,18 @@ class PushNotificationIOS {
   }
 
   /**
-   * Unregister for all remote notifications received via Apple Push Notification service.
+   * Unregister for all remote notifications received via Apple Push Notification
+   * service.
+   * You should call this method in rare circumstances only, such as when
+   * a new version of the app removes support for all types of remote
+   * notifications. Users can temporarily prevent apps from receiving
+   * remote notifications through the Notifications section of the
+   * Settings app. Apps unregistered through this method can always
+   * re-register.
    *
-   * See https://reactnative.dev/docs/pushnotificationios.html#abandonpermissions
+   * See https://reactnative.dev/docs/pushnotificationios#abandonpermissions
    */
-  static abandonPermissions() {
+  static abandonPermissions(): void {
     invariant(
       NativePushNotificationManagerIOS,
       'PushNotificationManager is not available.',
@@ -345,12 +476,18 @@ class PushNotificationIOS {
   }
 
   /**
-   * See what push permissions are currently enabled. `callback` will be
-   * invoked with a `permissions` object.
+   * Check which push permissions are currently enabled. `callback` will be
+   * invoked with a `Permissions` object.
    *
-   * See https://reactnative.dev/docs/pushnotificationios.html#checkpermissions
+   *  - `alert` :boolean
+   *  - `badge` :boolean
+   *  - `sound` :boolean
+   *
+   * See https://reactnative.dev/docs/pushnotificationios#checkpermissions
    */
-  static checkPermissions(callback: Function) {
+  static checkPermissions(
+    callback: (permissions: PushNotificationPermissions) => void,
+  ): void {
     invariant(typeof callback === 'function', 'Must provide a valid callback');
     invariant(
       NativePushNotificationManagerIOS,
@@ -363,9 +500,9 @@ class PushNotificationIOS {
    * This method returns a promise that resolves to either the notification
    * object if the app was launched by a push notification, or `null` otherwise.
    *
-   * See https://reactnative.dev/docs/pushnotificationios.html#getinitialnotification
+   * See https://reactnative.dev/docs/pushnotificationios#getinitialnotification
    */
-  static getInitialNotification(): Promise<?PushNotificationIOS> {
+  static getInitialNotification(): Promise<?PushNotification> {
     invariant(
       NativePushNotificationManagerIOS,
       'PushNotificationManager is not available.',
@@ -377,10 +514,25 @@ class PushNotificationIOS {
     );
   }
 
+  /**
+   * This method returns a promise that resolves to the current notification
+   * authorization status. See UNAuthorizationStatus for possible values.
+   */
+  static getAuthorizationStatus(
+    callback: (authorizationStatus: number) => void,
+  ): void {
+    invariant(
+      NativePushNotificationManagerIOS,
+      'PushNotificationManager is not available.',
+    );
+
+    NativePushNotificationManagerIOS.getAuthorizationStatus(callback);
+  }
+
   /**
    * You will never need to instantiate `PushNotificationIOS` yourself.
    * Listening to the `notification` event and invoking
-   * `getInitialNotification` is sufficient
+   * `getInitialNotification` is sufficient.
    *
    */
   constructor(nativeNotif: Object) {
@@ -393,7 +545,7 @@ class PushNotificationIOS {
 
     if (nativeNotif.remote) {
       // Extract data from Apple's `aps` dict as defined:
-      // https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/ApplePushService.html
+      // https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/ApplePushService
       Object.keys(nativeNotif).forEach(notifKey => {
         const notifVal = nativeNotif[notifKey];
         if (notifKey === 'aps') {
@@ -419,11 +571,12 @@ class PushNotificationIOS {
 
   /**
    * This method is available for remote notifications that have been received via:
-   * `application:didReceiveRemoteNotification:fetchCompletionHandler:`
+   * `application:didReceiveRemoteNotification:fetchCompletionHandler:`. See docs
+   * for more information.
    *
-   * See https://reactnative.dev/docs/pushnotificationios.html#finish
+   * See https://reactnative.dev/docs/pushnotificationios#finish
    */
-  finish(fetchResult: string) {
+  finish(fetchResult: string): void {
     if (
       !this._isRemote ||
       !this._notificationId ||
@@ -444,7 +597,7 @@ class PushNotificationIOS {
   }
 
   /**
-   * An alias for `getAlert` to get the notification's main message string
+   * An alias for `getAlert` to get the notification's main message string.
    */
   getMessage(): ?string | ?Object {
     // alias because "alert" is an ambiguous name
@@ -452,67 +605,69 @@ class PushNotificationIOS {
   }
 
   /**
-   * Gets the sound string from the `aps` object
+   * Gets the sound string from the `aps` object. This will be `null` for local
+   * notifications.
    *
-   * See https://reactnative.dev/docs/pushnotificationios.html#getsound
+   * See https://reactnative.dev/docs/pushnotificationios#getsound
    */
   getSound(): ?string {
     return this._sound;
   }
 
   /**
-   * Gets the category string from the `aps` object
+   * Gets the category string from the `aps` object.
    *
-   * See https://reactnative.dev/docs/pushnotificationios.html#getcategory
+   * See https://reactnative.dev/docs/pushnotificationios#getcategory
    */
   getCategory(): ?string {
     return this._category;
   }
 
   /**
-   * Gets the notification's main message from the `aps` object
+   * Gets the notification's main message from the `aps` object. Also see the
+   * alias: `getMessage()`.
    *
-   * See https://reactnative.dev/docs/pushnotificationios.html#getalert
+   * See https://reactnative.dev/docs/pushnotificationios#getalert
    */
   getAlert(): ?string | ?Object {
     return this._alert;
   }
 
   /**
-   * Gets the content-available number from the `aps` object
+   * Gets the content-available number from the `aps` object.
    *
-   * See https://reactnative.dev/docs/pushnotificationios.html#getcontentavailable
+   * See https://reactnative.dev/docs/pushnotificationios#getcontentavailable
    */
   getContentAvailable(): ContentAvailable {
     return this._contentAvailable;
   }
 
   /**
-   * Gets the badge count number from the `aps` object
+   * Gets the badge count number from the `aps` object.
    *
-   * See https://reactnative.dev/docs/pushnotificationios.html#getbadgecount
+   * See https://reactnative.dev/docs/pushnotificationios#getbadgecount
    */
   getBadgeCount(): ?number {
     return this._badgeCount;
   }
 
   /**
-   * Gets the data object on the notif
+   * Gets the data object on the notification.
    *
-   * See https://reactnative.dev/docs/pushnotificationios.html#getdata
+   * See https://reactnative.dev/docs/pushnotificationios#getdata
    */
   getData(): ?Object {
     return this._data;
   }
 
   /**
-   * Gets the thread ID on the notif
+   * Gets the thread ID on the notification.
    *
-   * See https://reactnative.dev/docs/pushnotificationios.html#getthreadid
+   * See https://reactnative.dev/docs/pushnotificationios#getthreadid
    */
   getThreadID(): ?string {
     return this._threadID;
   }
 }
 
-module.exports = PushNotificationIOS;
+export default PushNotificationIOS;

package/Libraries/QuirkSettings/CachingNativeQuirkSettings.js

@@ -0,0 +1,30 @@
+/**
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * @format
+ * @flow strict
+ */
+
+import NativeQuirkStorage from './NativeQuirkSettings';
+import type {Spec as NativeQuirkSettingsSpec} from './NativeQuirkSettings';
+import type {Quirks} from './Quirks';
+import {DefaultQuirks} from './Quirks';
+
+let cachedQuirks: ?Quirks = null;
+
+const CachingNativeQuirkSettings: NativeQuirkSettingsSpec = {
+  getConstants: () => {
+    if (cachedQuirks != null) {
+      return cachedQuirks;
+    } else if (NativeQuirkStorage) {
+      cachedQuirks = NativeQuirkStorage.getConstants();
+      return cachedQuirks;
+    } else {
+      cachedQuirks = DefaultQuirks;
+      return cachedQuirks;
+    }
+  },
+};
+
+export default CachingNativeQuirkSettings;

package/Libraries/QuirkSettings/NativeQuirkSettings.js

@@ -0,0 +1,17 @@
+/**
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * @format
+ * @flow strict
+ */
+
+import type {TurboModule} from '../TurboModule/RCTExport';
+import * as TurboModuleRegistry from '../TurboModule/TurboModuleRegistry';
+import type {Quirks} from './Quirks';
+
+export interface Spec extends TurboModule {
+  +getConstants: () => Quirks;
+}
+
+export default (TurboModuleRegistry.get<Spec>('QuirkSettings'): ?Spec);