expo-screen-orientation 6.0.1 → 6.0.3

package/CHANGELOG.md

@@ -10,6 +10,18 @@
 
 ### 💡 Others
 
+## 6.0.3 — 2023-07-12
+
+### 🐛 Bug fixes
+
+- [iOS] When config plugin is not configured the initial orientation is now based on values in `Info.plist` instead of being set to portrait. ([#23456](https://github.com/expo/expo/pull/23456) by [@behenate](https://github.com/behenate))
+
+## 6.0.2 — 2023-07-04
+
+### 💡 Others
+
+- [iOS] Refactor the singleton class to work properly in versioned code in Expo Go. ([#23228](https://github.com/expo/expo/pull/23228) by [@tsapeta](https://github.com/tsapeta))
+
 ## 6.0.1 — 2023-06-23
 
 ### 🐛 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.1'
+version = '6.0.3'
 
 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.1'
+    versionName '6.0.3'
   }
   lintOptions {
     abortOnError false

package/ios/ScreenOrientationAppDelegate.swift

@@ -2,6 +2,7 @@
 
 import ExpoModulesCore
 
+@objc(EXScreenOrientationAppDelegate)
 public class ScreenOrientationAppDelegate: ExpoAppDelegateSubscriber {
   public func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil) -> Bool {
     ScreenOrientationRegistry.shared.updateCurrentScreenOrientation()

package/ios/ScreenOrientationModule.swift

@@ -1,6 +1,6 @@
 import ExpoModulesCore
 
-public class ScreenOrientationModule: Module, OrientationListener, Hashable {
+public class ScreenOrientationModule: Module, ScreenOrientationController {
   static let didUpdateDimensionsEvent = "expoDidUpdateDimensions"
 
   let screenOrientationRegistry = ScreenOrientationRegistry.shared
@@ -22,7 +22,7 @@ public class ScreenOrientationModule: Module, OrientationListener, Hashable {
         throw UnsupportedOrientationLockException(orientationLock)
       }
 
-      screenOrientationRegistry.setMask(orientationMask, forModule: self)
+      screenOrientationRegistry.setMask(orientationMask, forController: self)
     }
 
     AsyncFunction("lockPlatformAsync") { (allowedOrientations: [ModuleOrientation]) in
@@ -43,7 +43,7 @@ public class ScreenOrientationModule: Module, OrientationListener, Hashable {
         throw UnsupportedOrientationLockException(nil)
       }
 
-      screenOrientationRegistry.setMask(allowedOrientationsMask, forModule: self)
+      screenOrientationRegistry.setMask(allowedOrientationsMask, forController: self)
     }
 
     AsyncFunction("getOrientationLockAsync") {
@@ -75,23 +75,18 @@ public class ScreenOrientationModule: Module, OrientationListener, Hashable {
       return ModuleOrientation.from(orientation: screenOrientationRegistry.currentScreenOrientation).rawValue
     }
 
-    OnStartObserving {
-      screenOrientationRegistry.registerModuleToReceiveNotification(self)
-    }
-
-    OnStopObserving {
-      screenOrientationRegistry.unregisterModuleFromReceivingNotification(self)
+    OnCreate {
+      screenOrientationRegistry.registerController(self)
     }
 
     OnDestroy {
-      screenOrientationRegistry.unregisterModuleFromReceivingNotification(self)
-      screenOrientationRegistry.moduleWillDeallocate(self)
+      screenOrientationRegistry.unregisterController(self)
     }
   }
 
-  // MARK: - ScreenOrientationListener
+  // MARK: - ScreenOrientationController
 
-  func screenOrientationDidChange(_ orientation: UIInterfaceOrientation) {
+  public func screenOrientationDidChange(_ orientation: UIInterfaceOrientation) {
     guard let currentTraitCollection = screenOrientationRegistry.currentTraitCollection else {
       return
     }
@@ -105,14 +100,4 @@ public class ScreenOrientationModule: Module, OrientationListener, Hashable {
       ] as [String: Any]
     ])
   }
-
-  // MARK: - Hashable
-
-  public func hash(into hasher: inout Hasher) {
-    hasher.combine(ObjectIdentifier(self))
-  }
-
-  public static func == (lhs: ScreenOrientationModule, rhs: ScreenOrientationModule) -> Bool {
-    return ObjectIdentifier(lhs) == ObjectIdentifier(rhs)
-  }
 }

package/ios/ScreenOrientationReactDelegateHandler.swift

@@ -2,6 +2,7 @@
 
 import ExpoModulesCore
 
+@objc(EXScreenOrientationReactDelegateHandler)
 public class ScreenOrientationReactDelegateHandler: ExpoReactDelegateHandler {
   public override func createRootViewController(reactDelegate: ExpoReactDelegate) -> UIViewController? {
     return ScreenOrientationViewController(defaultScreenOrientationFromPlist: ())

package/ios/ScreenOrientationRegistry.swift

@@ -1,7 +1,7 @@
 import Foundation
 import ExpoModulesCore
 
-protocol OrientationListener {
+public protocol ScreenOrientationController: AnyObject {
   func screenOrientationDidChange(_ orientation: UIInterfaceOrientation)
 }
 
@@ -14,10 +14,10 @@ public class ScreenOrientationRegistry: NSObject, UIApplicationDelegate {
   @objc
   public static let shared = ScreenOrientationRegistry()
 
-  var currentScreenOrientation: UIInterfaceOrientation
-  var orientationListeners: [ScreenOrientationModule?] = []
-  var moduleInterfaceMasks: [ScreenOrientationModule: UIInterfaceOrientationMask] = [:]
-  weak var currentTraitCollection: UITraitCollection?
+  public var currentScreenOrientation: UIInterfaceOrientation
+  var orientationControllers: [ScreenOrientationController] = []
+  var controllerInterfaceMasks: [ObjectIdentifier: UIInterfaceOrientationMask] = [:]
+  public weak var currentTraitCollection: UITraitCollection?
   var lastOrientationMask: UIInterfaceOrientationMask
   var rootViewController: UIViewController? {
     let keyWindow = UIApplication
@@ -29,7 +29,7 @@ public class ScreenOrientationRegistry: NSObject, UIApplicationDelegate {
     return keyWindow?.rootViewController
   }
 
-  var currentOrientationMask: UIInterfaceOrientationMask {
+  public var currentOrientationMask: UIInterfaceOrientationMask {
     var currentOrientationMask: UIInterfaceOrientationMask = []
 
     EXUtilities.performSynchronously {
@@ -61,7 +61,7 @@ public class ScreenOrientationRegistry: NSObject, UIApplicationDelegate {
   /**
    Called by ScreenOrientationAppDelegate in order to set initial interface orientation.
    */
-  func updateCurrentScreenOrientation() {
+  public func updateCurrentScreenOrientation() {
     let windows = UIApplication.shared.windows
     if !windows.isEmpty {
       self.currentScreenOrientation = windows[0].windowScene?.interfaceOrientation ?? .unknown
@@ -112,8 +112,10 @@ public class ScreenOrientationRegistry: NSObject, UIApplicationDelegate {
     }
   }
 
-  func setMask(_ mask: UIInterfaceOrientationMask, forModule module: ScreenOrientationModule) {
-    moduleInterfaceMasks[module] = mask
+  public func setMask(_ mask: UIInterfaceOrientationMask, forController controller: any ScreenOrientationController) {
+    let controllerIdentifier = ObjectIdentifier(controller)
+
+    controllerInterfaceMasks[controllerIdentifier] = mask
     enforceDesiredDeviceOrientation(withOrientationMask: mask)
   }
 
@@ -124,14 +126,14 @@ public class ScreenOrientationRegistry: NSObject, UIApplicationDelegate {
    */
   @objc
   public func requiredOrientationMask() -> UIInterfaceOrientationMask {
-    if moduleInterfaceMasks.isEmpty {
+    if controllerInterfaceMasks.isEmpty {
       return []
     }
 
     // We want to apply an orientation mask which is an intersection of locks applied by the modules.
     var mask = doesDeviceHaveNotch ? UIInterfaceOrientationMask.allButUpsideDown : UIInterfaceOrientationMask.all
 
-    for moduleMask in moduleInterfaceMasks {
+    for moduleMask in controllerInterfaceMasks {
       mask = mask.intersection(moduleMask.value)
     }
 
@@ -231,28 +233,24 @@ public class ScreenOrientationRegistry: NSObject, UIApplicationDelegate {
   }
 
   /**
-   Called at the end of the screen orientation change. Notifies modules about the orientation change.
+   Called at the end of the screen orientation change. Notifies the controllers about the orientation change.
    */
   func screenOrientationDidChange(_ newScreenOrientation: UIInterfaceOrientation) {
     currentScreenOrientation = newScreenOrientation
-    for module in orientationListeners {
-      module?.screenOrientationDidChange(newScreenOrientation)
+
+    for controller in orientationControllers {
+      controller.screenOrientationDidChange(newScreenOrientation)
     }
   }
 
-  func moduleWillDeallocate(_ module: ScreenOrientationModule) {
-    moduleInterfaceMasks.removeValue(forKey: module)
+  public func registerController(_ controller: ScreenOrientationController) {
+    orientationControllers.append(controller)
   }
 
-  func registerModuleToReceiveNotification(_ module: ScreenOrientationModule) {
-    orientationListeners.append(module)
-  }
+  public func unregisterController(_ controller: ScreenOrientationController) {
+    let controllerIdentifier = ObjectIdentifier(controller)
 
-  func unregisterModuleFromReceivingNotification(_ module: ScreenOrientationModule) {
-    for i in (0..<orientationListeners.count).reversed() {
-      if orientationListeners[i] === module || orientationListeners[i] == nil {
-        orientationListeners.remove(at: i)
-      }
-    }
+    controllerInterfaceMasks.removeValue(forKey: controllerIdentifier)
+    orientationControllers.removeAll(where: { $0 === controller })
   }
 }

package/ios/ScreenOrientationUtilities.swift

@@ -73,6 +73,21 @@ internal func plistStringToInterfaceOrientationMask(_ maskName: String) -> UIInt
   }
 }
 
+internal func orientationStringToInterfaceOrientationMask(_ orientationString: String) -> UIInterfaceOrientationMask? {
+  switch orientationString {
+  case "UIInterfaceOrientationPortrait":
+    return .portrait
+  case "UIInterfaceOrientationPortraitUpsideDown":
+    return .portraitUpsideDown
+  case "UIInterfaceOrientationLandscapeRight":
+    return .landscapeRight
+  case "UIInterfaceOrientationLandscapeLeft":
+    return .landscapeLeft
+  default:
+    return nil
+  }
+}
+
 extension UIInterfaceOrientation {
   internal func toInterfaceOrientationMask() -> UIInterfaceOrientationMask {
     return UIInterfaceOrientationMask(rawValue: 1 << self.rawValue)

package/ios/ScreenOrientationViewController.swift

@@ -1,34 +1,44 @@
 import ExpoModulesCore
 
-let defaultScreenOrientationMask = "EXDefaultScreenOrientationMask"
+let defaultScreenOrientationMaskKey = "EXDefaultScreenOrientationMask"
+let supportedOrientationsKey = "UISupportedInterfaceOrientations"
+let ipadSupportedOrientationsKey = "UISupportedInterfaceOrientations~ipad"
 
 class ScreenOrientationViewController: UIViewController {
   let screenOrientationRegistry = ScreenOrientationRegistry.shared
   private var defaultOrientationMask: UIInterfaceOrientationMask
 
-  init(defaultOrientationMask: UIInterfaceOrientationMask = .portrait) {
+  init(defaultOrientationMask: UIInterfaceOrientationMask = doesDeviceHaveNotch ? .allButUpsideDown : .all) {
     self.defaultOrientationMask = defaultOrientationMask
     super.init(nibName: nil, bundle: nil)
   }
 
   convenience init(defaultScreenOrientationFromPlist: Void) {
-    guard let orientationString = Bundle.main.object(forInfoDictionaryKey: defaultScreenOrientationMask) as? String else {
-      self.init(defaultOrientationMask: .portrait)
+    let supportedInterfaceOrientations = ScreenOrientationViewController.getSupportedInterfaceOrientations()
+
+    guard let orientationString = Bundle.main.object(forInfoDictionaryKey: defaultScreenOrientationMaskKey) as? String else {
+      // If user hasn't defined a default interface orientation using the config plugin use the allowed values from Info.plist as the
+      // default orientation. Values in Info.plist are set with the "orientation" key in app.json
+      self.init(defaultOrientationMask: supportedInterfaceOrientations)
       return
     }
 
     guard let mask = plistStringToInterfaceOrientationMask(orientationString) else {
-      log.warn("Orientation lock string '\(orientationString)' provided in Info.plist does not correspond to a valid orientation mask. Application will default to portrait orientation lock.")
-      self.init(defaultOrientationMask: .portrait)
+      log.warn("Orientation lock string '\(orientationString)' provided in Info.plist does not correspond to a valid orientation mask. Application will default to orientation mask set in \(supportedOrientationsKey).")
+      self.init(defaultOrientationMask: supportedInterfaceOrientations)
       return
     }
 
     guard mask.isSupportedByDevice() else {
-      log.warn("Orientation lock string '\(orientationString)' provided in Info.plist is not supported by the device. Application will default to portrait orientation lock.")
-      self.init(defaultOrientationMask: .portrait)
+      log.warn("Orientation lock string '\(orientationString)' provided in Info.plist is not supported by the device. Application will default to orientation lock set in \(supportedOrientationsKey).")
+      self.init(defaultOrientationMask: supportedInterfaceOrientations)
       return
     }
 
+    if mask != mask.intersection(supportedInterfaceOrientations) {
+      log.warn("Info.plist: Orientations allowed in `\(supportedOrientationsKey)` are in conflict with the values allowed in `\(defaultScreenOrientationMaskKey)`. Values from `\(defaultScreenOrientationMaskKey)` will be used. When setting the initial orientation using the config plugin delete the `\"orientation\"` key from `app.json`")
+    }
+
     self.init(defaultOrientationMask: mask)
   }
 
@@ -61,4 +71,27 @@ class ScreenOrientationViewController: UIViewController {
     }
     return screenWindowTraitsClass.shouldAskScreensForScreenOrientation?(in: self) ?? false
   }
+
+  /**
+   * Parses the lists under the key 'UISupportedInterfaceOrientations' in Info.plist into a UIInterfaceOrientation mask. Also checks for ipad specific settings.
+   * If no orientation is found all possible orientations will be returned.
+   */
+  private static func getSupportedInterfaceOrientations() -> UIInterfaceOrientationMask {
+    let allPossibleOrientations: UIInterfaceOrientationMask = doesDeviceHaveNotch ? .allButUpsideDown : .all
+    let ipadSupportedOrientationStrings = Bundle.main.object(forInfoDictionaryKey: ipadSupportedOrientationsKey) as? [String] ?? []
+    let commonSupportedOrientationStrings = Bundle.main.object(forInfoDictionaryKey: supportedOrientationsKey) as? [String] ?? []
+    let supportedOrientationStrings = (isPad() && !ipadSupportedOrientationStrings.isEmpty) ?
+      ipadSupportedOrientationStrings : commonSupportedOrientationStrings
+    var orientationMask: UIInterfaceOrientationMask = []
+
+    for orientationString in supportedOrientationStrings {
+      guard let orientation = orientationStringToInterfaceOrientationMask(orientationString) else {
+        log.warn("Info.plist: \(orientationString) is not a valid value for the \(supportedOrientationsKey) key")
+        continue
+      }
+      orientationMask.insert(orientation)
+    }
+
+    return orientationMask.isEmpty ? allPossibleOrientations : orientationMask
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-screen-orientation",
-  "version": "6.0.1",
+  "version": "6.0.3",
   "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": "a72ae33519fe54eaf195dc3e61a49db8345103db"
+  "gitHead": "8fdc53c90c52242a80ea511ee3073d9ab950bc68"
 }