@react-native-firebase/auth 21.6.1 → 21.7.0

package/plugin/build/ios/openUrlFix.js

@@ -0,0 +1,150 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.multiline_appDelegateOpenUrlInsertionPointAfter = exports.appDelegateOpenUrlInsertionPointAfter = exports.withIosCaptchaOpenUrlFix = void 0;
+exports.shouldApplyIosOpenUrlFix = shouldApplyIosOpenUrlFix;
+exports.withOpenUrlFixForAppDelegate = withOpenUrlFixForAppDelegate;
+exports.modifyObjcAppDelegate = modifyObjcAppDelegate;
+exports.isFirebaseSwizzlingDisabled = isFirebaseSwizzlingDisabled;
+exports.ensureFirebaseSwizzlingIsEnabled = ensureFirebaseSwizzlingIsEnabled;
+const config_plugins_1 = require("@expo/config-plugins");
+const generateCode_1 = require("@expo/config-plugins/build/utils/generateCode");
+const withIosCaptchaOpenUrlFix = (config, props) => {
+    // check configuration
+    if (!shouldApplyIosOpenUrlFix({ config, props })) {
+        return config;
+    }
+    // check that swizzling is enabled; otherwise patch must be customized and applied manually
+    (0, config_plugins_1.withInfoPlist)(config, config => {
+        ensureFirebaseSwizzlingIsEnabled(config);
+        return config;
+    });
+    // apply patch
+    return (0, config_plugins_1.withAppDelegate)(config, config => {
+        return withOpenUrlFixForAppDelegate({ config, props });
+    });
+};
+exports.withIosCaptchaOpenUrlFix = withIosCaptchaOpenUrlFix;
+// Interpret the plugin config to determine whether this fix should be applied
+function shouldApplyIosOpenUrlFix({ config, props, }) {
+    const flag = props?.ios?.captchaOpenUrlFix;
+    if (flag === undefined || flag === 'default') {
+        // by default, apply the fix whenever 'expo-router' is detected in the same project
+        return isPluginEnabled(config, 'expo-router');
+    }
+    else if (flag === true || flag === false) {
+        const isEnabled = flag;
+        return isEnabled;
+    }
+    else {
+        throw new Error(`Unexpected value for 'captchaOpenUrlFix' config option`);
+    }
+}
+function withOpenUrlFixForAppDelegate({ config, props, }) {
+    const { language, contents } = config.modResults;
+    const configValue = props?.ios?.captchaOpenUrlFix || 'default';
+    if (['objc', 'objcpp'].includes(language)) {
+        const newContents = modifyObjcAppDelegate(contents);
+        if (newContents === null) {
+            if (configValue === true) {
+                throw new Error("Failed to apply iOS openURL fix because no 'openURL' method was found");
+            }
+            else {
+                config_plugins_1.WarningAggregator.addWarningIOS('@react-native-firebase/auth', "Skipping iOS openURL fix because no 'openURL' method was found");
+                return config;
+            }
+        }
+        else {
+            if (configValue === 'default') {
+                config_plugins_1.WarningAggregator.addWarningIOS('@react-native-firebase/auth', 'modifying iOS AppDelegate openURL method to ignore firebaseauth reCAPTCHA redirect URLs');
+            }
+            return {
+                ...config,
+                modResults: {
+                    ...config.modResults,
+                    contents: newContents,
+                },
+            };
+        }
+    }
+    else {
+        // TODO: Support Swift
+        throw new Error(`Don't know how to apply openUrlFix to AppDelegate of language "${language}"`);
+    }
+}
+const skipOpenUrlForFirebaseAuthBlock = `\
+  if ([url.host caseInsensitiveCompare:@"firebaseauth"] == NSOrderedSame) {
+    // invocations for Firebase Auth are handled elsewhere and should not be forwarded to Expo Router
+    return NO;
+  }\
+`;
+// NOTE: `mergeContents()` requires that this pattern not match newlines
+exports.appDelegateOpenUrlInsertionPointAfter = /-\s*\(\s*BOOL\s*\)\s*application\s*:\s*\(\s*UIApplication\s*\*\s*\)\s*application\s+openURL\s*:\s*\(\s*NSURL\s*\*\s*\)\s*url\s+options\s*:\s*\(\s*NSDictionary\s*<\s*UIApplicationOpenURLOptionsKey\s*,\s*id\s*>\s*\*\s*\)\s*options\s*/; // 🙈
+exports.multiline_appDelegateOpenUrlInsertionPointAfter = new RegExp(exports.appDelegateOpenUrlInsertionPointAfter.source + '\\s*{\\s*\\n');
+// Returns contents of new AppDelegate with modification applied, or returns null if this patch is not applicable because the AppDelegate doesn't have an 'openURL' method to handle deep links.
+function modifyObjcAppDelegate(contents) {
+    const pattern = exports.appDelegateOpenUrlInsertionPointAfter;
+    const multilinePattern = exports.multiline_appDelegateOpenUrlInsertionPointAfter;
+    const fullMatch = contents.match(multilinePattern);
+    if (!fullMatch) {
+        if (contents.match(pattern)) {
+            throw new Error("Failed to find insertion point; expected newline after '{'");
+        }
+        else if (contents.match(/openURL\s*:/)) {
+            throw new Error([
+                "Failed to apply 'captchaOpenUrlFix' but detected 'openURL' method.",
+                "Please manually apply the fix to your AppDelegate's openURL method,",
+                "then update your app.config.json by configuring the '@react-native-firebase/auth' plugin",
+                'to set `captchaOpenUrlFix: false`.',
+            ].join(' '));
+        }
+        else {
+            // openURL method was not found in AppDelegate
+            return null;
+        }
+    }
+    const fullMatchNumLines = fullMatch[0].split('\n').length;
+    const offset = fullMatchNumLines - 1;
+    if (offset < 0) {
+        throw new Error(`Failed to find insertion point; fullMatchNumLines=${fullMatchNumLines}`);
+    }
+    return (0, generateCode_1.mergeContents)({
+        tag: '@react-native-firebase/auth-openURL',
+        src: contents,
+        newSrc: skipOpenUrlForFirebaseAuthBlock,
+        anchor: exports.appDelegateOpenUrlInsertionPointAfter,
+        offset,
+        comment: '//',
+    }).contents;
+}
+// Search the ExpoConfig plugins array to see if `pluginName` is present
+function isPluginEnabled(config, pluginName) {
+    if (config.plugins === undefined) {
+        return false;
+    }
+    return config.plugins.some((plugin) => {
+        if (plugin === pluginName) {
+            return true;
+        }
+        else if (Array.isArray(plugin) && plugin.length >= 1 && plugin[0] === pluginName) {
+            return true;
+        }
+        else {
+            return false;
+        }
+    });
+}
+function isFirebaseSwizzlingDisabled(config) {
+    return config.ios?.infoPlist?.['FirebaseAppDelegateProxyEnabled'] === false;
+}
+function ensureFirebaseSwizzlingIsEnabled(config) {
+    if (isFirebaseSwizzlingDisabled(config)) {
+        throw new Error([
+            'Your app has disabled swizzling by setting FirebaseAppDelegateProxyEnabled=false in its Info.plist.',
+            "Please update your app.config.json to configure the '@react-native-firebase/auth' plugin to set `captchaOpenUrlFix: false`",
+            'and see https://firebase.google.com/docs/auth/ios/phone-auth#appendix:-using-phone-sign-in-without-swizzling for instructions.',
+        ].join(' '));
+    }
+    else {
+        return true;
+    }
+}

package/plugin/build/ios/urlTypes.d.ts

@@ -1,5 +1,6 @@
 import { ConfigPlugin, IOSConfig, ExportedConfigWithProps } from '@expo/config-plugins';
-export declare const withIosCaptchaUrlTypes: ConfigPlugin;
+import { PluginConfigType } from '../pluginConfig';
+export declare const withIosCaptchaUrlTypes: ConfigPlugin<PluginConfigType>;
 export declare function setUrlTypesForCaptcha({ config, }: {
     config: ExportedConfigWithProps<IOSConfig.InfoPlist>;
 }): ExportedConfigWithProps<IOSConfig.InfoPlist>;

package/plugin/build/pluginConfig.d.ts

@@ -0,0 +1,6 @@
+export interface PluginConfigType {
+    ios?: PluginConfigTypeIos;
+}
+export interface PluginConfigTypeIos {
+    captchaOpenUrlFix?: undefined | boolean | 'default';
+}

package/plugin/build/pluginConfig.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/plugin/src/index.ts

@@ -1,14 +1,16 @@
 import { ConfigPlugin, withPlugins, createRunOncePlugin } from '@expo/config-plugins';
 
-import { withIosCaptchaUrlTypes } from './ios';
+import { withIosCaptchaUrlTypes, withIosCaptchaOpenUrlFix } from './ios';
+import { PluginConfigType } from './pluginConfig';
 
 /**
  * A config plugin for configuring `@react-native-firebase/auth`
  */
-const withRnFirebaseAuth: ConfigPlugin = config => {
+const withRnFirebaseAuth: ConfigPlugin<PluginConfigType> = (config, props) => {
   return withPlugins(config, [
     // iOS
-    withIosCaptchaUrlTypes,
+    [withIosCaptchaUrlTypes, props],
+    [withIosCaptchaOpenUrlFix, props],
   ]);
 };
 

package/plugin/src/ios/index.ts

@@ -1,3 +1,4 @@
 import { withIosCaptchaUrlTypes } from './urlTypes';
+import { withIosCaptchaOpenUrlFix } from './openUrlFix';
 
-export { withIosCaptchaUrlTypes };
+export { withIosCaptchaUrlTypes, withIosCaptchaOpenUrlFix };

package/plugin/src/ios/openUrlFix.ts

@@ -0,0 +1,186 @@
+import {
+  ConfigPlugin,
+  withAppDelegate,
+  withInfoPlist,
+  ExportedConfigWithProps,
+  WarningAggregator,
+} from '@expo/config-plugins';
+import type { ExpoConfig } from '@expo/config/build/Config.types';
+import type { AppDelegateProjectFile } from '@expo/config-plugins/build/ios/Paths';
+import type { InfoPlist } from '@expo/config-plugins/build/ios/IosConfig.types';
+import { mergeContents } from '@expo/config-plugins/build/utils/generateCode';
+import { PluginConfigType } from '../pluginConfig';
+
+export const withIosCaptchaOpenUrlFix: ConfigPlugin<PluginConfigType> = (
+  config: ExpoConfig,
+  props?: PluginConfigType,
+) => {
+  // check configuration
+  if (!shouldApplyIosOpenUrlFix({ config, props })) {
+    return config;
+  }
+
+  // check that swizzling is enabled; otherwise patch must be customized and applied manually
+  withInfoPlist(config, config => {
+    ensureFirebaseSwizzlingIsEnabled(config);
+    return config;
+  });
+
+  // apply patch
+  return withAppDelegate(config, config => {
+    return withOpenUrlFixForAppDelegate({ config, props });
+  });
+};
+
+// Interpret the plugin config to determine whether this fix should be applied
+export function shouldApplyIosOpenUrlFix({
+  config,
+  props,
+}: {
+  config: ExpoConfig;
+  props?: PluginConfigType;
+}): boolean {
+  const flag = props?.ios?.captchaOpenUrlFix;
+  if (flag === undefined || flag === 'default') {
+    // by default, apply the fix whenever 'expo-router' is detected in the same project
+    return isPluginEnabled(config, 'expo-router');
+  } else if (flag === true || flag === false) {
+    const isEnabled: boolean = flag;
+    return isEnabled;
+  } else {
+    throw new Error(`Unexpected value for 'captchaOpenUrlFix' config option`);
+  }
+}
+
+export function withOpenUrlFixForAppDelegate({
+  config,
+  props,
+}: {
+  config: ExportedConfigWithProps<AppDelegateProjectFile>;
+  props?: PluginConfigType;
+}) {
+  const { language, contents } = config.modResults;
+  const configValue = props?.ios?.captchaOpenUrlFix || 'default';
+
+  if (['objc', 'objcpp'].includes(language)) {
+    const newContents = modifyObjcAppDelegate(contents);
+    if (newContents === null) {
+      if (configValue === true) {
+        throw new Error("Failed to apply iOS openURL fix because no 'openURL' method was found");
+      } else {
+        WarningAggregator.addWarningIOS(
+          '@react-native-firebase/auth',
+          "Skipping iOS openURL fix because no 'openURL' method was found",
+        );
+        return config;
+      }
+    } else {
+      if (configValue === 'default') {
+        WarningAggregator.addWarningIOS(
+          '@react-native-firebase/auth',
+          'modifying iOS AppDelegate openURL method to ignore firebaseauth reCAPTCHA redirect URLs',
+        );
+      }
+      return {
+        ...config,
+        modResults: {
+          ...config.modResults,
+          contents: newContents,
+        },
+      };
+    }
+  } else {
+    // TODO: Support Swift
+    throw new Error(`Don't know how to apply openUrlFix to AppDelegate of language "${language}"`);
+  }
+}
+
+const skipOpenUrlForFirebaseAuthBlock: string = `\
+  if ([url.host caseInsensitiveCompare:@"firebaseauth"] == NSOrderedSame) {
+    // invocations for Firebase Auth are handled elsewhere and should not be forwarded to Expo Router
+    return NO;
+  }\
+`;
+
+// NOTE: `mergeContents()` requires that this pattern not match newlines
+export const appDelegateOpenUrlInsertionPointAfter: RegExp =
+  /-\s*\(\s*BOOL\s*\)\s*application\s*:\s*\(\s*UIApplication\s*\*\s*\)\s*application\s+openURL\s*:\s*\(\s*NSURL\s*\*\s*\)\s*url\s+options\s*:\s*\(\s*NSDictionary\s*<\s*UIApplicationOpenURLOptionsKey\s*,\s*id\s*>\s*\*\s*\)\s*options\s*/; // 🙈
+
+export const multiline_appDelegateOpenUrlInsertionPointAfter = new RegExp(
+  appDelegateOpenUrlInsertionPointAfter.source + '\\s*{\\s*\\n',
+);
+
+// Returns contents of new AppDelegate with modification applied, or returns null if this patch is not applicable because the AppDelegate doesn't have an 'openURL' method to handle deep links.
+export function modifyObjcAppDelegate(contents: string): string | null {
+  const pattern = appDelegateOpenUrlInsertionPointAfter;
+  const multilinePattern = multiline_appDelegateOpenUrlInsertionPointAfter;
+  const fullMatch = contents.match(multilinePattern);
+  if (!fullMatch) {
+    if (contents.match(pattern)) {
+      throw new Error("Failed to find insertion point; expected newline after '{'");
+    } else if (contents.match(/openURL\s*:/)) {
+      throw new Error(
+        [
+          "Failed to apply 'captchaOpenUrlFix' but detected 'openURL' method.",
+          "Please manually apply the fix to your AppDelegate's openURL method,",
+          "then update your app.config.json by configuring the '@react-native-firebase/auth' plugin",
+          'to set `captchaOpenUrlFix: false`.',
+        ].join(' '),
+      );
+    } else {
+      // openURL method was not found in AppDelegate
+      return null;
+    }
+  }
+  const fullMatchNumLines = fullMatch[0].split('\n').length;
+  const offset = fullMatchNumLines - 1;
+  if (offset < 0) {
+    throw new Error(`Failed to find insertion point; fullMatchNumLines=${fullMatchNumLines}`);
+  }
+  return mergeContents({
+    tag: '@react-native-firebase/auth-openURL',
+    src: contents,
+    newSrc: skipOpenUrlForFirebaseAuthBlock,
+    anchor: appDelegateOpenUrlInsertionPointAfter,
+    offset,
+    comment: '//',
+  }).contents;
+}
+
+export type ExpoConfigPluginEntry = string | [] | [string] | [string, any];
+
+// Search the ExpoConfig plugins array to see if `pluginName` is present
+function isPluginEnabled(config: ExpoConfig, pluginName: string): boolean {
+  if (config.plugins === undefined) {
+    return false;
+  }
+  return config.plugins.some((plugin: ExpoConfigPluginEntry) => {
+    if (plugin === pluginName) {
+      return true;
+    } else if (Array.isArray(plugin) && plugin.length >= 1 && plugin[0] === pluginName) {
+      return true;
+    } else {
+      return false;
+    }
+  });
+}
+
+export function isFirebaseSwizzlingDisabled(config: ExportedConfigWithProps<InfoPlist>): boolean {
+  return config.ios?.infoPlist?.['FirebaseAppDelegateProxyEnabled'] === false;
+}
+
+export function ensureFirebaseSwizzlingIsEnabled(
+  config: ExportedConfigWithProps<InfoPlist>,
+): boolean {
+  if (isFirebaseSwizzlingDisabled(config)) {
+    throw new Error(
+      [
+        'Your app has disabled swizzling by setting FirebaseAppDelegateProxyEnabled=false in its Info.plist.',
+        "Please update your app.config.json to configure the '@react-native-firebase/auth' plugin to set `captchaOpenUrlFix: false`",
+        'and see https://firebase.google.com/docs/auth/ios/phone-auth#appendix:-using-phone-sign-in-without-swizzling for instructions.',
+      ].join(' '),
+    );
+  } else {
+    return true;
+  }
+}

package/plugin/src/ios/urlTypes.ts

@@ -7,9 +7,10 @@ import {
 import fs from 'fs';
 import path from 'path';
 import plist from 'plist';
+import { PluginConfigType } from '../pluginConfig';
 
 // does this for you: https://firebase.google.com/docs/auth/ios/phone-auth#enable-phone-number-sign-in-for-your-firebase-project
-export const withIosCaptchaUrlTypes: ConfigPlugin = config => {
+export const withIosCaptchaUrlTypes: ConfigPlugin<PluginConfigType> = config => {
   return withInfoPlist(config, config => {
     return setUrlTypesForCaptcha({ config });
   });

package/plugin/src/pluginConfig.ts

@@ -0,0 +1,7 @@
+export interface PluginConfigType {
+  ios?: PluginConfigTypeIos;
+}
+
+export interface PluginConfigTypeIos {
+  captchaOpenUrlFix?: undefined | boolean | 'default';
+}

package/plugin/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["./src/index.ts","./src/ios/index.ts","./src/ios/urlTypes.ts"],"version":"5.6.2"}
+{"root":["./src/index.ts","./src/pluginConfig.ts","./src/ios/index.ts","./src/ios/openUrlFix.ts","./src/ios/urlTypes.ts"],"version":"5.6.2"}