expo-web-browser 10.0.3 → 10.2.0

package/ios/WebBrowserSession.swift

@@ -0,0 +1,63 @@
+// Copyright 2022-present 650 Industries. All rights reserved.
+
+import SafariServices
+import ExpoModulesCore
+
+internal class WebBrowserSession: NSObject, SFSafariViewControllerDelegate, UIAdaptivePresentationControllerDelegate {
+  let viewController: SFSafariViewController
+  var promise: Promise?
+  var isOpen: Bool {
+    promise != nil
+  }
+
+  init(url: URL, options: WebBrowserOptions) {
+    let configuration = SFSafariViewController.Configuration()
+    configuration.barCollapsingEnabled = options.enableBarCollapsing
+    configuration.entersReaderIfAvailable = options.readerMode
+
+    viewController = SFSafariViewController(url: url, configuration: configuration)
+    viewController.modalPresentationStyle = options.presentationStyle.toPresentationStyle()
+    viewController.dismissButtonStyle = options.dismissButtonStyle.toSafariDismissButtonStyle()
+    viewController.preferredBarTintColor = options.toolbarColor
+    viewController.preferredControlTintColor = options.controlsColor
+
+    super.init()
+    viewController.delegate = self
+    viewController.presentationController?.delegate = self
+  }
+
+  func open(_ promise: Promise) {
+    var currentViewController = UIApplication.shared.keyWindow?.rootViewController
+    while currentViewController?.presentedViewController != nil {
+      currentViewController = currentViewController?.presentedViewController
+    }
+    currentViewController?.present(viewController, animated: true, completion: nil)
+
+    self.promise = promise
+  }
+
+  func dismiss() {
+    viewController.dismiss(animated: true) {
+      self.finish(type: "dismiss")
+    }
+  }
+
+  // MARK: - SFSafariViewControllerDelegate
+
+  func safariViewControllerDidFinish(_ controller: SFSafariViewController) {
+    finish(type: "cancel")
+  }
+  
+  // MARK: - UIAdaptivePresentationControllerDelegate
+
+  func presentationControllerDidDismiss(_ presentationController: UIPresentationController) {
+    finish(type: "cancel")
+  }
+
+  // MARK: - Private
+
+  private func finish(type: String) {
+    promise?.resolve(["type": type])
+    promise = nil
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-web-browser",
-  "version": "10.0.3",
+  "version": "10.2.0",
   "description": "Provides access to the system's web browser and supports handling redirects. On iOS, it uses SFSafariViewController or SFAuthenticationSession, depending on the method you call, and on Android it uses ChromeCustomTabs. As of iOS 11, SFSafariViewController no longer shares cookies with Safari, so if you are using WebBrowser for authentication you will want to use WebBrowser.openAuthSessionAsync, and if you just want to open a webpage (such as your app privacy policy), then use WebBrowser.openBrowserAsync.",
   "main": "build/WebBrowser.js",
   "types": "build/WebBrowser.d.ts",
@@ -36,11 +36,13 @@
     "preset": "expo-module-scripts"
   },
   "dependencies": {
-    "compare-urls": "^2.0.0",
-    "expo-modules-core": "~0.4.4"
+    "compare-urls": "^2.0.0"
   },
   "devDependencies": {
     "expo-module-scripts": "^2.0.0"
   },
-  "gitHead": "4fa0497a180ae707fa860cb03858630ab7af19f4"
+  "peerDependencies": {
+    "expo": "*"
+  },
+  "gitHead": "22dce752354bb429c84851bc4389abe47a766b1f"
 }

package/src/ExpoWebBrowser.web.ts

@@ -133,7 +133,7 @@ export default {
       if (popupWindow) {
         try {
           popupWindow.focus();
-        } catch (e) {}
+        } catch {}
       } else {
         throw new CodedError(
           'ERR_WEB_BROWSER_BLOCKED',

package/src/WebBrowser.ts

@@ -16,6 +16,8 @@ import {
   WebBrowserResultType,
   WebBrowserWarmUpResult,
   WebBrowserWindowFeatures,
+  WebBrowserPresentationStyle,
+  AuthSessionOpenOptions,
 } from './WebBrowser.types';
 
 export {
@@ -31,6 +33,8 @@ export {
   WebBrowserResultType,
   WebBrowserWarmUpResult,
   WebBrowserWindowFeatures,
+  WebBrowserPresentationStyle,
+  AuthSessionOpenOptions,
 };
 
 const emptyCustomTabsPackages: WebBrowserCustomTabsResults = {
@@ -42,12 +46,13 @@ const emptyCustomTabsPackages: WebBrowserCustomTabsResults = {
 
 // @needsAudit
 /**
- * _Android only_. Returns a list of applications package names supporting Custom Tabs, Custom Tabs
+ * Returns a list of applications package names supporting Custom Tabs, Custom Tabs
  * service, user chosen and preferred one. This may not be fully reliable, since it uses
  * `PackageManager.getResolvingActivities` under the hood. (For example, some browsers might not be
  * present in browserPackages list once another browser is set to default.)
  *
  * @return The promise which fulfils with [`WebBrowserCustomTabsResults`](#webbrowsercustomtabsresults) object.
+ * @platform android
  */
 export async function getCustomTabsSupportingBrowsersAsync(): Promise<WebBrowserCustomTabsResults> {
   if (!ExponentWebBrowser.getCustomTabsSupportingBrowsersAsync) {
@@ -62,12 +67,13 @@ export async function getCustomTabsSupportingBrowsersAsync(): Promise<WebBrowser
 
 // @needsAudit
 /**
- * _Android only_. This method calls `warmUp` method on [CustomTabsClient](https://developer.android.com/reference/android/support/customtabs/CustomTabsClient.html#warmup(long))
+ * This method calls `warmUp` method on [CustomTabsClient](https://developer.android.com/reference/android/support/customtabs/CustomTabsClient.html#warmup(long))
  * for specified package.
  *
- * @param browserPackage _Optional_ - Package of browser to be warmed up. If not set, preferred browser will be warmed.
+ * @param browserPackage Package of browser to be warmed up. If not set, preferred browser will be warmed.
  *
- * @return A promise which fulfils with `{ package: string }` object.
+ * @return A promise which fulfils with `WebBrowserWarmUpResult` object.
+ * @platform android
  */
 export async function warmUpAsync(browserPackage?: string): Promise<WebBrowserWarmUpResult> {
   if (!ExponentWebBrowser.warmUpAsync) {
@@ -82,13 +88,15 @@ export async function warmUpAsync(browserPackage?: string): Promise<WebBrowserWa
 
 // @needsAudit
 /**
- * _Android only_. This method initiates (if needed) [CustomTabsSession](https://developer.android.com/reference/android/support/customtabs/CustomTabsSession.html#maylaunchurl)
+ * This method initiates (if needed) [CustomTabsSession](https://developer.android.com/reference/android/support/customtabs/CustomTabsSession.html#maylaunchurl)
  * and calls its `mayLaunchUrl` method for browser specified by the package.
  *
  * @param url The url of page that is likely to be loaded first when opening browser.
- * @param browserPackage _Optional_ - Package of browser to be informed. If not set, preferred browser will be used.
+ * @param browserPackage Package of browser to be informed. If not set, preferred
+ * browser will be used.
  *
- * @return A promise which fulfils with `{ package: string }` object.
+ * @return A promise which fulfils with `WebBrowserMayInitWithUrlResult` object.
+ * @platform android
  */
 export async function mayInitWithUrlAsync(
   url: string,
@@ -106,15 +114,16 @@ export async function mayInitWithUrlAsync(
 
 // @needsAudit
 /**
- * _Android only_. This methods removes all bindings to services created by [`warmUpAsync`](#webbrowserwarmupasyncbrowserpackage)
+ * This methods removes all bindings to services created by [`warmUpAsync`](#webbrowserwarmupasyncbrowserpackage)
  * or [`mayInitWithUrlAsync`](#webbrowsermayinitwithurlasyncurl-browserpackage). You should call
  * this method once you don't need them to avoid potential memory leaks. However, those binding
  * would be cleared once your application is destroyed, which might be sufficient in most cases.
  *
- * @param browserPackage _Optional_ - Package of browser to be cooled. If not set, preferred browser will be used.
+ * @param browserPackage Package of browser to be cooled. If not set, preferred browser will be used.
  *
- * @return The promise which fulfils with `{ package: string }` when cooling is performed, or
+ * @return The promise which fulfils with ` WebBrowserCoolDownResult` when cooling is performed, or
  * an empty object when there was no connection to be dismissed.
+ * @platform android
  */
 export async function coolDownAsync(browserPackage?: string): Promise<WebBrowserCoolDownResult> {
   if (!ExponentWebBrowser.coolDownAsync) {
@@ -179,9 +188,10 @@ export async function openBrowserAsync(
 
 // @needsAudit
 /**
- * _iOS only_. Dismisses the presented web browser.
+ * Dismisses the presented web browser.
  *
- * @return The promise which fulfils with `{ type: 'dismiss' }` object.
+ * @return The `void` on successful attempt, or throws error, if dismiss functionality is not avaiable.
+ * @platform ios
  */
 export function dismissBrowser(): void {
   if (!ExponentWebBrowser.dismissBrowser) {
@@ -225,7 +235,7 @@ export function dismissBrowser(): void {
  *
  * @param url The url to open in the web browser. This should be a login page.
  * @param redirectUrl _Optional_ - The url to deep link back into your app. By default, this will be [`Constants.linkingUrl`](./constants/#expoconstantslinkinguri).
- * @param browserParams _Optional_ - An object with the same keys as [`WebBrowserOpenOptions`](#webbrowseropenoptions).
+ * @param options _Optional_ - An object extending the [`WebBrowserOpenOptions`](#webbrowseropenoptions).
  * If there is no native AuthSession implementation available (which is the case on Android)
  * these params will be used in the browser polyfill. If there is a native AuthSession implementation,
  * these params will be ignored.
@@ -239,18 +249,18 @@ export function dismissBrowser(): void {
 export async function openAuthSessionAsync(
   url: string,
   redirectUrl: string,
-  browserParams: WebBrowserOpenOptions = {}
+  options: AuthSessionOpenOptions = {}
 ): Promise<WebBrowserAuthSessionResult> {
   if (_authSessionIsNativelySupported()) {
     if (!ExponentWebBrowser.openAuthSessionAsync) {
       throw new UnavailabilityError('WebBrowser', 'openAuthSessionAsync');
     }
-    if (Platform.OS === 'web') {
-      return ExponentWebBrowser.openAuthSessionAsync(url, redirectUrl, browserParams);
+    if (['ios', 'web'].includes(Platform.OS)) {
+      return ExponentWebBrowser.openAuthSessionAsync(url, redirectUrl, options);
     }
     return ExponentWebBrowser.openAuthSessionAsync(url, redirectUrl);
   } else {
-    return _openAuthSessionPolyfillAsync(url, redirectUrl, browserParams);
+    return _openAuthSessionPolyfillAsync(url, redirectUrl, options);
   }
 }
 
@@ -271,7 +281,7 @@ export function dismissAuthSession(): void {
 
 // @needsAudit
 /**
- * _Web only_. Possibly completes an authentication session on web in a window popup. The method
+ * Possibly completes an authentication session on web in a window popup. The method
  * should be invoked on the page that the window redirects to.
  *
  * @param options
@@ -295,6 +305,8 @@ export function dismissAuthSession(): void {
  *
  * If the error `ERR_WEB_BROWSER_REDIRECT` was thrown, it may mean that the parent window was
  * reloaded before the auth was completed. In this case you'll need to close the child window manually.
+ *
+ * @platform web
  */
 export function maybeCompleteAuthSession(
   options: WebBrowserCompleteAuthSessionOptions = {}
@@ -351,8 +363,8 @@ async function _openBrowserAndWaitAndroidAsync(
 ): Promise<WebBrowserResult> {
   const appStateChangedToActive = new Promise<void>((resolve) => {
     _onWebBrowserCloseAndroid = resolve;
-    AppState.addEventListener('change', _onAppStateChangeAndroid);
   });
+  const stateChangeSubscription = AppState.addEventListener('change', _onAppStateChangeAndroid);
 
   let result: WebBrowserResult = { type: WebBrowserResultType.CANCEL };
   let type: string | null = null;
@@ -360,7 +372,7 @@ async function _openBrowserAndWaitAndroidAsync(
   try {
     ({ type } = await openBrowserAsync(startUrl, browserParams));
   } catch (e) {
-    AppState.removeEventListener('change', _onAppStateChangeAndroid);
+    stateChangeSubscription.remove();
     _onWebBrowserCloseAndroid = null;
     throw e;
   }
@@ -370,7 +382,7 @@ async function _openBrowserAndWaitAndroidAsync(
     result = { type: WebBrowserResultType.DISMISS };
   }
 
-  AppState.removeEventListener('change', _onAppStateChangeAndroid);
+  stateChangeSubscription.remove();
   _onWebBrowserCloseAndroid = null;
   return result;
 }

package/src/WebBrowser.types.ts

@@ -12,8 +12,9 @@ export type WebBrowserOpenOptions = {
    */
   toolbarColor?: string;
   /**
-   * __(Android only)__. Package name of a browser to be used to handle Custom Tabs. List of
+   * Package name of a browser to be used to handle Custom Tabs. List of
    * available packages is to be queried by [`getCustomTabsSupportingBrowsers`](#webbrowsergetcustomtabssupportingbrowsersasync) method.
+   * @platform android
    */
   browserPackage?: string;
   /**
@@ -21,51 +22,84 @@ export type WebBrowserOpenOptions = {
    */
   enableBarCollapsing?: boolean;
   /**
-   * __(Android only)__ Color of the secondary toolbar in either `#AARRGGBB` or `#RRGGBB` format.
+   * Color of the secondary toolbar in either `#AARRGGBB` or `#RRGGBB` format.
+   * @platform android
    */
   secondaryToolbarColor?: string;
   /**
-   * __(Android only)__ A boolean determining whether the browser should show the title of website on the toolbar.
+   * A boolean determining whether the browser should show the title of website on the toolbar.
+   * @platform android
    */
   showTitle?: boolean;
   /**
-   * __(Android only)__ A boolean determining whether a default share item should be added to the menu.
+   * A boolean determining whether a default share item should be added to the menu.
+   * @platform android
    */
   enableDefaultShareMenuItem?: boolean;
   /**
-   * __(Android only)__ A boolean determining whether browsed website should be shown as separate
+   * A boolean determining whether browsed website should be shown as separate
    * entry in Android recents/multitasking view. Requires `createTask` to be `true` (default).
-   * @default `false`
+   * @default false
+   * @platform android
    */
   showInRecents?: boolean;
   /**
-   * __(Android only)__ A boolean determining whether the browser should open in a new task or in
+   * A boolean determining whether the browser should open in a new task or in
    * the same task as your app.
-   * @default `true`
+   * @default true
+   * @platform android
    */
   createTask?: boolean;
   /**
-   * __(iOS only)__ Tint color for controls in SKSafariViewController in `#AARRGGBB` or `#RRGGBB` format.
+   * Tint color for controls in SKSafariViewController in `#AARRGGBB` or `#RRGGBB` format.
+   * @platform ios
    */
   controlsColor?: string;
   /**
-   * __(iOS only)__ The style of the dismiss button. Should be one of: `done`, `close`, or `cancel`.
+   * The style of the dismiss button. Should be one of: `done`, `close`, or `cancel`.
+   * @platform ios
    */
   dismissButtonStyle?: 'done' | 'close' | 'cancel';
   /**
-   * __(iOS only)__ A boolean determining whether Safari should enter Reader mode, if it is available.
+   * A boolean determining whether Safari should enter Reader mode, if it is available.
+   * @platform ios
    */
   readerMode?: boolean;
   /**
-   * __(Web only)__ Name to assign to the popup window.
+   * The [presentation style](https://developer.apple.com/documentation/uikit/uiviewcontroller/1621355-modalpresentationstyle)
+   * of the browser window.
+   * @default WebBrowser.WebBrowserPresentationStyle.OverFullScreen
+   * @platform ios
+   */
+  presentationStyle?: WebBrowserPresentationStyle;
+  /**
+   * Name to assign to the popup window.
+   * @platform web
    */
   windowName?: string;
   /**
-   * __(Web only)__ Features to use with `window.open()`.
+   * Features to use with `window.open()`.
+   * @platform web
    */
   windowFeatures?: string | WebBrowserWindowFeatures;
 };
 
+/**
+ * If there is no native AuthSession implementation available (which is the case on Android) the params inherited from
+ * [`WebBrowserOpenOptions`](#webbrowseropenoptions) will be used in the browser polyfill. Otherwise, the browser parameters will be ignored.
+ */
+export type AuthSessionOpenOptions = WebBrowserOpenOptions & {
+  /**
+   * Determines whether the session should ask the browser for a private authentication session.
+   * Set this to `true` to request that the browser doesn’t share cookies or other browsing data between the authentication session and the user’s normal browser session.
+   * Whether the request is honored depends on the user’s default web browser.
+   *
+   * @default false
+   * @platform ios 13+
+   */
+  preferEphemeralSession?: boolean;
+};
+
 export type WebBrowserAuthSessionResult = WebBrowserRedirectResult | WebBrowserResult;
 
 // @needsAudit
@@ -99,20 +133,64 @@ export type WebBrowserCustomTabsResults = {
 // @needsAudit @docsMissing
 export enum WebBrowserResultType {
   /**
-   * iOS only.
+   * @platform ios
    */
   CANCEL = 'cancel',
   /**
-   * iOS only.
+   * @platform ios
    */
   DISMISS = 'dismiss',
   /**
-   * Android only.
+   * @platform android
    */
   OPENED = 'opened',
   LOCKED = 'locked',
 }
 
+// @needsAudit
+/**
+ * A browser presentation style. Its values are directly mapped to the [`UIModalPresentationStyle`](https://developer.apple.com/documentation/uikit/uiviewcontroller/1621355-modalpresentationstyle).
+ *
+ * @platform ios
+ */
+export enum WebBrowserPresentationStyle {
+  /**
+   * A presentation style in which the presented browser covers the screen.
+   */
+  FULL_SCREEN = 'fullScreen',
+  /**
+   * A presentation style that partially covers the underlying content.
+   */
+  PAGE_SHEET = 'pageSheet',
+  /**
+   * A presentation style that displays the browser centered in the screen.
+   */
+  FORM_SHEET = 'formSheet',
+  /**
+   * A presentation style where the browser is displayed over the app's content.
+   */
+  CURRENT_CONTEXT = 'currentContext',
+  /**
+   * A presentation style in which the browser view covers the screen.
+   */
+  OVER_FULL_SCREEN = 'overFullScreen',
+  /**
+   * A presentation style where the browser is displayed over the app's content.
+   */
+  OVER_CURRENT_CONTEXT = 'overCurrentContext',
+  /**
+   * A presentation style where the browser is displayed in a popover view.
+   */
+  POPOVER = 'popover',
+  /**
+   * The default presentation style chosen by the system.
+   * On older iOS versions, falls back to `WebBrowserPresentationStyle.FullScreen`.
+   *
+   * @platform ios 13+
+   */
+  AUTOMATIC = 'automatic',
+}
+
 // @needsAudit
 export type WebBrowserResult = {
   /**

package/ios/EXWebBrowser/EXWebBrowser.h

@@ -1,9 +0,0 @@
-//  Copyright © 2018 650 Industries. All rights reserved.
-
-#import <ExpoModulesCore/EXExportedModule.h>
-#import <ExpoModulesCore/EXModuleRegistryConsumer.h>
-
-@interface EXWebBrowser : EXExportedModule <EXModuleRegistryConsumer>
-
-
-@end