expo-screen-orientation 6.0.3 → 6.0.5

package/CHANGELOG.md

@@ -10,6 +10,19 @@
 
 ### 💡 Others
 
+## 6.0.5 — 2023-07-25
+
+### 🐛 Bug fixes
+
+- Fix addOrientationChangeListener not working on iPadOS. ([#23656](https://github.com/expo/expo/pull/23656) by [@behenate](https://github.com/behenate))
+
+## 6.0.4 — 2023-07-23
+
+### 🐛 Bug fixes
+
+- [iOS] Fix event emitter sending events with no registered listeners. ([#23462](https://github.com/expo/expo/pull/23462) by [@behenate](https://github.com/behenate))
+- [iOS] Fix config plugin deleting the orientations key from `Info.plist` when the initial orientation value is set to `DEFAULT`. ([#23637](https://github.com/expo/expo/pull/23637) by [@behenate](https://github.com/behenate))
+
 ## 6.0.3 — 2023-07-12
 
 ### 🐛 Bug fixes

package/android/build.gradle

@@ -3,7 +3,7 @@ apply plugin: 'kotlin-android'
 apply plugin: 'maven-publish'
 
 group = 'host.exp.exponent'
-version = '6.0.3'
+version = '6.0.5'
 
 buildscript {
   def expoModulesCorePlugin = new File(project(":expo-modules-core").projectDir.absolutePath, "ExpoModulesCorePlugin.gradle")
@@ -67,7 +67,7 @@ android {
     minSdkVersion safeExtGet("minSdkVersion", 21)
     targetSdkVersion safeExtGet("targetSdkVersion", 33)
     versionCode 7
-    versionName '6.0.3'
+    versionName '6.0.5'
   }
   lintOptions {
     abortOnError false

package/ios/ScreenOrientationModule.swift

@@ -4,7 +4,7 @@ public class ScreenOrientationModule: Module, ScreenOrientationController {
   static let didUpdateDimensionsEvent = "expoDidUpdateDimensions"
 
   let screenOrientationRegistry = ScreenOrientationRegistry.shared
-  var eventEmitter: EXEventEmitterService?
+  var shouldEmitEvents = false
 
   public func definition() -> ModuleDefinition {
     Name("ExpoScreenOrientation")
@@ -82,12 +82,20 @@ public class ScreenOrientationModule: Module, ScreenOrientationController {
     OnDestroy {
       screenOrientationRegistry.unregisterController(self)
     }
+
+    OnStartObserving {
+      shouldEmitEvents = true
+    }
+
+    OnStopObserving {
+      shouldEmitEvents = false
+    }
   }
 
   // MARK: - ScreenOrientationController
 
   public func screenOrientationDidChange(_ orientation: UIInterfaceOrientation) {
-    guard let currentTraitCollection = screenOrientationRegistry.currentTraitCollection else {
+    guard let currentTraitCollection = screenOrientationRegistry.currentTraitCollection, shouldEmitEvents else {
       return
     }
 

package/ios/ScreenOrientationRegistry.swift

@@ -17,6 +17,7 @@ public class ScreenOrientationRegistry: NSObject, UIApplicationDelegate {
   public var currentScreenOrientation: UIInterfaceOrientation
   var orientationControllers: [ScreenOrientationController] = []
   var controllerInterfaceMasks: [ObjectIdentifier: UIInterfaceOrientationMask] = [:]
+  @objc
   public weak var currentTraitCollection: UITraitCollection?
   var lastOrientationMask: UIInterfaceOrientationMask
   var rootViewController: UIViewController? {
@@ -45,13 +46,6 @@ public class ScreenOrientationRegistry: NSObject, UIApplicationDelegate {
 
     super.init()
 
-    NotificationCenter.default.addObserver(
-      self,
-      selector: #selector(self.handleDeviceOrientationChange(notification:)),
-      name: UIDevice.orientationDidChangeNotification,
-      object: UIDevice.current
-    )
-
     // This is most likely already executed on the main thread, but we need to be sure
     RCTExecuteOnMainQueue {
       UIDevice.current.beginGeneratingDeviceOrientationNotifications()
@@ -79,7 +73,8 @@ public class ScreenOrientationRegistry: NSObject, UIApplicationDelegate {
   /**
    Rotates the view to currentScreenOrientation or default orientation from the orientationMask.
    */
-  func enforceDesiredDeviceOrientation(withOrientationMask orientationMask: UIInterfaceOrientationMask) {
+  @objc
+  public func enforceDesiredDeviceOrientation(withOrientationMask orientationMask: UIInterfaceOrientationMask) {
     var newOrientation = orientationMask.defaultOrientation()
 
     if orientationMask.contains(currentScreenOrientation) {
@@ -142,56 +137,19 @@ public class ScreenOrientationRegistry: NSObject, UIApplicationDelegate {
 
   // MARK: - Events
 
-  /**
-   Called when the OS sends an OrientationDidChange notification.
-   */
-  @objc
-  func handleDeviceOrientationChange(notification: Notification) {
-    let newScreenOrientation = UIDevice.current.orientation.toInterfaceOrientation()
-
-    interfaceOrientationDidChange(newScreenOrientation)
-  }
-
-  /**
-   Called when the device is physically rotated. Checks if screen orientation should be changed after user rotated the device.
-   */
-  func interfaceOrientationDidChange(_ newScreenOrientation: UIInterfaceOrientation) {
-    if currentScreenOrientation == newScreenOrientation || newScreenOrientation == .unknown {
-      return
-    }
-
-    if currentOrientationMask.contains(newScreenOrientation) {
-      // when changing orientation without changing dimensions traitCollectionDidChange isn't triggered so the event has to be called manually
-      if (newScreenOrientation.isPortrait && currentScreenOrientation.isPortrait)
-        || (newScreenOrientation.isLandscape && currentScreenOrientation.isLandscape) {
-        screenOrientationDidChange(newScreenOrientation)
-        return
-      }
-
-      // on iPads, traitCollectionDidChange isn't triggered at all, so we have to call screenOrientationDidChange manually
-      if isPad()
-        && (newScreenOrientation.isPortrait && currentScreenOrientation.isLandscape
-        || newScreenOrientation.isLandscape && currentScreenOrientation.isPortrait) {
-        screenOrientationDidChange(newScreenOrientation)
-      }
-    }
-  }
-
   /**
    Called by ScreenOrientationViewController when the dimensions of the view change.
    Also used for Expo Go in EXAppViewController.
    */
   @objc
-  public func traitCollectionDidChange(to traitCollection: UITraitCollection) {
-    currentTraitCollection = traitCollection
-
+  public func viewDidTransition(toOrientation orientation: UIInterfaceOrientation) {
     let currentDeviceOrientation = UIDevice.current.orientation.toInterfaceOrientation()
     let currentOrientationMask = self.rootViewController?.supportedInterfaceOrientations ?? []
 
     var newScreenOrientation = UIInterfaceOrientation.unknown
 
     // We need to deduce what is the new screen orientaiton based on currentOrientationMask and new dimensions of the view
-    if traitCollection.isPortrait() {
+    if orientation.isPortrait {
       // From trait collection, we know that screen is in portrait or upside down orientation.
       let portraitMask = currentOrientationMask.intersection([.portrait, .portraitUpsideDown])
 
@@ -208,7 +166,7 @@ public class ScreenOrientationRegistry: NSObject, UIApplicationDelegate {
         // from device orientation.
         newScreenOrientation = currentDeviceOrientation
       }
-    } else if traitCollection.isLandscape() {
+    } else if orientation.isLandscape {
       // From trait collection, we know that screen is in landscape left or right orientation.
       let landscapeMask = currentOrientationMask.intersection(.landscape)
 
@@ -232,6 +190,11 @@ public class ScreenOrientationRegistry: NSObject, UIApplicationDelegate {
     screenOrientationDidChange(newScreenOrientation)
   }
 
+  @objc
+  public func traitCollectionDidChange(to traitCollection: UITraitCollection) {
+    currentTraitCollection = traitCollection
+  }
+
   /**
    Called at the end of the screen orientation change. Notifies the controllers about the orientation change.
    */

package/ios/ScreenOrientationViewController.swift

@@ -7,10 +7,20 @@ let ipadSupportedOrientationsKey = "UISupportedInterfaceOrientations~ipad"
 class ScreenOrientationViewController: UIViewController {
   let screenOrientationRegistry = ScreenOrientationRegistry.shared
   private var defaultOrientationMask: UIInterfaceOrientationMask
+  private var previousInterfaceOrientation: UIInterfaceOrientation = .unknown
+  private var windowInterfaceOrientation: UIInterfaceOrientation? {
+    return UIApplication.shared.windows.first?.windowScene?.interfaceOrientation
+  }
 
   init(defaultOrientationMask: UIInterfaceOrientationMask = doesDeviceHaveNotch ? .allButUpsideDown : .all) {
     self.defaultOrientationMask = defaultOrientationMask
     super.init(nibName: nil, bundle: nil)
+
+    // For iPads traitCollectionDidChange will not be called (it's always in the same size class). It is necessary
+    // to init it in here, so it's possible to return it in the didUpdateDimensionsEvent of the module
+    if self.screenOrientationRegistry.currentTraitCollection == nil {
+      self.screenOrientationRegistry.traitCollectionDidChange(to: self.traitCollection)
+    }
   }
 
   convenience init(defaultScreenOrientationFromPlist: Void) {
@@ -57,11 +67,23 @@ class ScreenOrientationViewController: UIViewController {
 
   override func traitCollectionDidChange(_ previousTraitCollection: UITraitCollection?) {
     super.traitCollectionDidChange(previousTraitCollection)
+    screenOrientationRegistry.traitCollectionDidChange(to: traitCollection)
+  }
 
-    if traitCollection.verticalSizeClass != previousTraitCollection?.verticalSizeClass ||
-      traitCollection.horizontalSizeClass != previousTraitCollection?.horizontalSizeClass {
-      screenOrientationRegistry.traitCollectionDidChange(to: traitCollection)
-    }
+  override func viewWillTransition(to size: CGSize, with coordinator: UIViewControllerTransitionCoordinator) {
+    super.viewWillTransition(to: size, with: coordinator)
+
+    // Update after the transition ends, this ensures that the trait collection passed to didUpdateDimensionsEvent is already updated
+    coordinator.animate(alongsideTransition: { [weak self] _ in
+      guard let self = self, let windowInterfaceOrientation = self.windowInterfaceOrientation else {
+        return
+      }
+
+      if windowInterfaceOrientation != self.previousInterfaceOrientation {
+        self.screenOrientationRegistry.viewDidTransition(toOrientation: windowInterfaceOrientation)
+      }
+      self.previousInterfaceOrientation = windowInterfaceOrientation
+    })
   }
 
   private func shouldUseRNScreenOrientation() -> Bool {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-screen-orientation",
-  "version": "6.0.3",
+  "version": "6.0.5",
   "description": "Expo universal module for managing device's screen orientation",
   "main": "build/ScreenOrientation.js",
   "types": "build/ScreenOrientation.d.ts",
@@ -41,5 +41,5 @@
   "peerDependencies": {
     "expo": "*"
   },
-  "gitHead": "8fdc53c90c52242a80ea511ee3073d9ab950bc68"
+  "gitHead": "8c85313e05e38401d06dcac1addd8a0659ae37a3"
 }

package/plugin/build/withScreenOrientation.d.ts

@@ -15,7 +15,6 @@ type OrientationMasks = keyof typeof OrientationLock;
 interface ExpoConfigWithInitialOrientation extends ExpoConfig {
     initialOrientation?: OrientationMasks;
 }
-export declare function getInitialOrientation(config: Pick<ExpoConfigWithInitialOrientation, 'initialOrientation'>): OrientationMasks;
 export declare function setInitialOrientation(config: Pick<ExpoConfigWithInitialOrientation, 'initialOrientation'>, infoPlist: InfoPlist): InfoPlist;
 declare const _default: ConfigPlugin<void | {
     initialOrientation?: "DEFAULT" | "ALL" | "PORTRAIT" | "PORTRAIT_UP" | "PORTRAIT_DOWN" | "LANDSCAPE" | "LANDSCAPE_LEFT" | "LANDSCAPE_RIGHT" | undefined;

package/plugin/build/withScreenOrientation.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setInitialOrientation = exports.getInitialOrientation = exports.INITIAL_ORIENTATION_KEY = void 0;
+exports.setInitialOrientation = exports.INITIAL_ORIENTATION_KEY = void 0;
 const assert_1 = __importDefault(require("assert"));
 const config_plugins_1 = require("expo/config-plugins");
 const pkg = require('expo-screen-orientation/package.json');
@@ -19,7 +19,7 @@ const OrientationLock = {
     LANDSCAPE_LEFT: 'UIInterfaceOrientationMaskLandscapeLeft',
     LANDSCAPE_RIGHT: 'UIInterfaceOrientationMaskLandscapeRight',
 };
-const withScreenOrientationViewController = (config, { initialOrientation = 'DEFAULT' } = {}) => {
+const withScreenOrientationViewController = (config, { initialOrientation } = {}) => {
     config = (0, config_plugins_1.withInfoPlist)(config, (config) => {
         const extendedConfig = {
             ...config,
@@ -30,19 +30,14 @@ const withScreenOrientationViewController = (config, { initialOrientation = 'DEF
     });
     return config;
 };
-function getInitialOrientation(config) {
-    return config.initialOrientation ?? 'DEFAULT';
-}
-exports.getInitialOrientation = getInitialOrientation;
 function setInitialOrientation(config, infoPlist) {
-    const initialOrientation = getInitialOrientation(config);
-    (0, assert_1.default)(initialOrientation in OrientationLock, `Invalid initial orientation "${initialOrientation}" expected one of: ${Object.keys(OrientationLock).join(', ')}`);
-    if (initialOrientation === 'DEFAULT') {
+    const initialOrientation = config.initialOrientation;
+    if (!initialOrientation) {
         delete infoPlist[exports.INITIAL_ORIENTATION_KEY];
+        return infoPlist;
     }
-    else {
-        infoPlist[exports.INITIAL_ORIENTATION_KEY] = OrientationLock[initialOrientation];
-    }
+    (0, assert_1.default)(initialOrientation in OrientationLock, `Invalid initial orientation "${initialOrientation}" expected one of: ${Object.keys(OrientationLock).join(', ')}`);
+    infoPlist[exports.INITIAL_ORIENTATION_KEY] = OrientationLock[initialOrientation];
     return infoPlist;
 }
 exports.setInitialOrientation = setInitialOrientation;

package/plugin/src/withScreenOrientation.ts

@@ -29,7 +29,7 @@ const withScreenOrientationViewController: ConfigPlugin<
   {
     initialOrientation?: keyof typeof OrientationLock;
   } | void
-> = (config, { initialOrientation = 'DEFAULT' } = {}) => {
+> = (config, { initialOrientation } = {}) => {
   config = withInfoPlist(config, (config) => {
     const extendedConfig = {
       ...config,
@@ -41,17 +41,16 @@ const withScreenOrientationViewController: ConfigPlugin<
   return config;
 };
 
-export function getInitialOrientation(
-  config: Pick<ExpoConfigWithInitialOrientation, 'initialOrientation'>
-): OrientationMasks {
-  return config.initialOrientation ?? 'DEFAULT';
-}
-
 export function setInitialOrientation(
   config: Pick<ExpoConfigWithInitialOrientation, 'initialOrientation'>,
   infoPlist: InfoPlist
 ): InfoPlist {
-  const initialOrientation = getInitialOrientation(config);
+  const initialOrientation = config.initialOrientation;
+
+  if (!initialOrientation) {
+    delete infoPlist[INITIAL_ORIENTATION_KEY];
+    return infoPlist;
+  }
 
   assert(
     initialOrientation in OrientationLock,
@@ -60,11 +59,8 @@ export function setInitialOrientation(
     ).join(', ')}`
   );
 
-  if (initialOrientation === 'DEFAULT') {
-    delete infoPlist[INITIAL_ORIENTATION_KEY];
-  } else {
-    infoPlist[INITIAL_ORIENTATION_KEY] = OrientationLock[initialOrientation];
-  }
+  infoPlist[INITIAL_ORIENTATION_KEY] = OrientationLock[initialOrientation];
+
   return infoPlist;
 }