expo-screen-orientation 6.0.2 → 6.0.4

package/CHANGELOG.md

@@ -10,6 +10,19 @@
 
 ### 💡 Others
 
+## 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
+
+- [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

package/android/build.gradle

@@ -3,7 +3,7 @@ apply plugin: 'kotlin-android'
 apply plugin: 'maven-publish'
 
 group = 'host.exp.exponent'
-version = '6.0.2'
+version = '6.0.4'
 
 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.2'
+    versionName '6.0.4'
   }
   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

@@ -79,7 +79,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) {

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.2",
+  "version": "6.0.4",
   "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": "cf90d5c30c2a08a6493ebfa8aa3791aa70666759"
+  "gitHead": "c0d646e9295094bca877513e500d3c9f2e990c42"
 }

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;
 }