@react-native-firebase/auth 16.3.1 → 16.4.1

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+### [16.4.1](https://github.com/invertase/react-native-firebase/compare/v16.4.0...v16.4.1) (2022-11-02)
+
+**Note:** Version bump only for package @react-native-firebase/auth
+
+## [16.4.0](https://github.com/invertase/react-native-firebase/compare/v16.3.1...v16.4.0) (2022-10-30)
+
+### Features
+
+- **auth:** Add Expo support for phone auth ([#6645](https://github.com/invertase/react-native-firebase/issues/6645)) ([97a4ea5](https://github.com/invertase/react-native-firebase/commit/97a4ea573dd0795b157e73299e705dbd7bb7e3d4))
+
 ### [16.3.1](https://github.com/invertase/react-native-firebase/compare/v16.3.0...v16.3.1) (2022-10-28)
 
 **Note:** Version bump only for package @react-native-firebase/auth

package/app.plugin.js

@@ -0,0 +1 @@
+module.exports = require('./plugin/build');

package/lib/version.js

@@ -1,2 +1,2 @@
 // Generated by genversion.
-module.exports = '16.3.1';
+module.exports = '16.4.1';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/auth",
-  "version": "16.3.1",
+  "version": "16.4.1",
   "author": "Invertase <oss@invertase.io> (http://invertase.io)",
   "description": "React Native Firebase - The authentication module provides an easy-to-use API to integrate an authentication workflow into new and existing applications. React Native Firebase provides access to all Firebase authentication methods and identity providers.",
   "main": "lib/index.js",
@@ -8,7 +8,9 @@
   "scripts": {
     "build": "genversion --semi lib/version.js",
     "build:clean": "rimraf android/build && rimraf ios/build",
-    "prepare": "yarn run build"
+    "build:plugin": "rimraf plugin/build && tsc --build plugin",
+    "lint:plugin": "eslint plugin/src/*",
+    "prepare": "yarn run build && yarn run build:plugin"
   },
   "repository": {
     "type": "git",
@@ -21,11 +23,18 @@
     "firebase",
     "auth"
   ],
+  "dependencies": {
+    "@expo/config-plugins": "^5.0.1",
+    "plist": "^3.0.5"
+  },
   "peerDependencies": {
-    "@react-native-firebase/app": "16.3.1"
+    "@react-native-firebase/app": "16.4.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "1f2385bfb90ee5cad2aab23332d1d13fdf0d81c2"
+  "devDependencies": {
+    "@types/plist": "^3.0.2"
+  },
+  "gitHead": "542cec866fb2e83b7fc4baf3be287bc2c3408229"
 }

package/plugin/__tests__/__snapshots__/iosPlugin.test.ts.snap

@@ -0,0 +1,13 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Config Plugin iOS Tests adds url types to the Info.plist 1`] = `
+{
+  "CFBundleURLTypes": [
+    {
+      "CFBundleURLSchemes": [
+        "com.googleusercontent.apps.SomeRandomClientIdString",
+      ],
+    },
+  ],
+}
+`;

package/plugin/__tests__/fixtures/TestGoogleService-Info.incomplete.plist

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+</dict>
+</plist>

package/plugin/__tests__/fixtures/TestGoogleService-Info.plist

@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CLIENT_ID</key>
+	<string>SomeRandomClientIdString.apps.googleusercontent.com</string>
+	<key>REVERSED_CLIENT_ID</key>
+	<string>com.googleusercontent.apps.SomeRandomClientIdString</string>
+	<key>ANDROID_CLIENT_ID</key>
+	<string>SomeRandomAndroidClientIdString.apps.googleusercontent.com</string>
+	<key>API_KEY</key>
+	<string>SomeRandomApiKeyString</string>
+	<key>GCM_SENDER_ID</key>
+	<string>SomeRandomGcmSenderIdNumber</string>
+	<key>PLIST_VERSION</key>
+	<string>1</string>
+	<key>BUNDLE_ID</key>
+	<string>com.example.app</string>
+	<key>PROJECT_ID</key>
+	<string>example</string>
+	<key>STORAGE_BUCKET</key>
+	<string>example.appspot.com</string>
+	<key>IS_ADS_ENABLED</key>
+	<false></false>
+	<key>IS_ANALYTICS_ENABLED</key>
+	<false></false>
+	<key>IS_APPINVITE_ENABLED</key>
+	<true></true>
+	<key>IS_GCM_ENABLED</key>
+	<true></true>
+	<key>IS_SIGNIN_ENABLED</key>
+	<true></true>
+	<key>GOOGLE_APP_ID</key>
+	<string>1234:1234:ios:1234</string>
+	<key>DATABASE_URL</key>
+	<string>https://example.firebaseio.com</string>
+</dict>
+</plist>

package/plugin/__tests__/iosPlugin.test.ts

@@ -0,0 +1,75 @@
+import path from 'path';
+import { beforeEach, describe, expect, it, jest } from '@jest/globals';
+import { setUrlTypesForCaptcha } from '../src/ios/urlTypes';
+
+describe('Config Plugin iOS Tests', () => {
+  beforeEach(function () {
+    jest.resetAllMocks();
+  });
+
+  it('throws if path to GoogleServer-Info.plist is not provided', async () => {
+    expect(() => {
+      setUrlTypesForCaptcha({
+        config: {
+          name: 'TestName',
+          slug: 'TestSlug',
+          modRequest: { projectRoot: path.join(__dirname, 'fixtures') } as any,
+          modResults: {},
+          modRawConfig: { name: 'TestName', slug: 'TestSlug' },
+          ios: {},
+        },
+      });
+    }).toThrow(
+      `[@react-native-firebase/auth] Your app.json file is missing ios.googleServicesFile. Please add this field.`,
+    );
+  });
+
+  it('throws if GoogleServer-Info.plist cannot be read', async () => {
+    const googleServiceFilePath = path.join(__dirname, 'fixtures', 'ThisFileDoesNotExist.plist');
+    expect(() => {
+      setUrlTypesForCaptcha({
+        config: {
+          name: 'TestName',
+          slug: 'TestSlug',
+          modRequest: { projectRoot: path.join(__dirname, 'fixtures') } as any,
+          modResults: {},
+          modRawConfig: { name: 'TestName', slug: 'TestSlug' },
+          ios: { googleServicesFile: 'ThisFileDoesNotExist.plist' },
+        },
+      });
+    }).toThrow(
+      `[@react-native-firebase/auth] GoogleService-Info.plist doesn't exist in ${googleServiceFilePath}. Place it there or configure the path in app.json`,
+    );
+  });
+
+  it('throws if GoogleServer-Info.plist has no reversed client id', async () => {
+    expect(() => {
+      setUrlTypesForCaptcha({
+        config: {
+          name: 'TestName',
+          slug: 'TestSlug',
+          modRequest: { projectRoot: path.join(__dirname, 'fixtures') } as any,
+          modResults: {},
+          modRawConfig: { name: 'TestName', slug: 'TestSlug' },
+          ios: { googleServicesFile: 'TestGoogleService-Info.incomplete.plist' },
+        },
+      });
+    }).toThrow(
+      '[@react-native-firebase/auth] Failed to parse your GoogleService-Info.plist. Are you sure it is a valid Info.Plist file with a REVERSE_CLIENT_ID field?',
+    );
+  });
+
+  it('adds url types to the Info.plist', async () => {
+    const result = setUrlTypesForCaptcha({
+      config: {
+        name: 'TestName',
+        slug: 'TestSlug',
+        modRequest: { projectRoot: path.join(__dirname, 'fixtures') } as any,
+        modResults: {},
+        modRawConfig: { name: 'TestName', slug: 'TestSlug' },
+        ios: { googleServicesFile: 'TestGoogleService-Info.plist' },
+      },
+    });
+    expect(result.modResults).toMatchSnapshot();
+  });
+});

package/plugin/build/index.d.ts

@@ -0,0 +1,3 @@
+import { ConfigPlugin } from '@expo/config-plugins';
+declare const _default: ConfigPlugin<void>;
+export default _default;

package/plugin/build/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const config_plugins_1 = require("@expo/config-plugins");
+const ios_1 = require("./ios");
+/**
+ * A config plugin for configuring `@react-native-firebase/auth`
+ */
+const withRnFirebaseAuth = config => {
+    return (0, config_plugins_1.withPlugins)(config, [
+        // iOS
+        ios_1.withIosCaptchaUrlTypes,
+    ]);
+};
+const pak = require('@react-native-firebase/auth/package.json');
+exports.default = (0, config_plugins_1.createRunOncePlugin)(withRnFirebaseAuth, pak.name, pak.version);

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

@@ -0,0 +1,2 @@
+import { withIosCaptchaUrlTypes } from './urlTypes';
+export { withIosCaptchaUrlTypes };

package/plugin/build/ios/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withIosCaptchaUrlTypes = void 0;
+const urlTypes_1 = require("./urlTypes");
+Object.defineProperty(exports, "withIosCaptchaUrlTypes", { enumerable: true, get: function () { return urlTypes_1.withIosCaptchaUrlTypes; } });

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

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

package/plugin/build/ios/urlTypes.js

@@ -0,0 +1,64 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setUrlTypesForCaptcha = exports.withIosCaptchaUrlTypes = void 0;
+const config_plugins_1 = require("@expo/config-plugins");
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const plist_1 = __importDefault(require("plist"));
+// does this for you: https://firebase.google.com/docs/auth/ios/phone-auth#enable-phone-number-sign-in-for-your-firebase-project
+const withIosCaptchaUrlTypes = config => {
+    return (0, config_plugins_1.withInfoPlist)(config, config => {
+        return setUrlTypesForCaptcha({ config });
+    });
+};
+exports.withIosCaptchaUrlTypes = withIosCaptchaUrlTypes;
+function getReversedClientId(googleServiceFilePath) {
+    try {
+        const googleServicePlist = fs_1.default.readFileSync(googleServiceFilePath, 'utf8');
+        const googleServiceJson = plist_1.default.parse(googleServicePlist);
+        const REVERSED_CLIENT_ID = googleServiceJson.REVERSED_CLIENT_ID;
+        if (!REVERSED_CLIENT_ID) {
+            throw new TypeError('REVERSED_CLIENT_ID missing');
+        }
+        return REVERSED_CLIENT_ID;
+    }
+    catch {
+        throw new Error('[@react-native-firebase/auth] Failed to parse your GoogleService-Info.plist. Are you sure it is a valid Info.Plist file with a REVERSE_CLIENT_ID field?');
+    }
+}
+// add phone auth support by configuring recaptcha
+// https://github.com/invertase/react-native-firebase/pull/6167
+function addUriScheme(config, reversedClientId) {
+    var _a;
+    if (!config.modResults) {
+        config.modResults = {};
+    }
+    if (!config.modResults.CFBundleURLTypes) {
+        config.modResults.CFBundleURLTypes = [];
+    }
+    const hasReverseClientId = (_a = config.modResults.CFBundleURLTypes) === null || _a === void 0 ? void 0 : _a.some(urlType => urlType.CFBundleURLSchemes.includes(reversedClientId));
+    if (!hasReverseClientId) {
+        config.modResults.CFBundleURLTypes.push({
+            CFBundleURLSchemes: [reversedClientId],
+        });
+    }
+    return config;
+}
+function setUrlTypesForCaptcha({ config, }) {
+    var _a;
+    const googleServicesFileRelativePath = (_a = config.ios) === null || _a === void 0 ? void 0 : _a.googleServicesFile;
+    if (!googleServicesFileRelativePath) {
+        throw new Error(`[@react-native-firebase/auth] Your app.json file is missing ios.googleServicesFile. Please add this field.`);
+    }
+    const googleServiceFilePath = path_1.default.resolve(config.modRequest.projectRoot, googleServicesFileRelativePath);
+    if (!fs_1.default.existsSync(googleServiceFilePath)) {
+        throw new Error(`[@react-native-firebase/auth] GoogleService-Info.plist doesn't exist in ${googleServiceFilePath}. Place it there or configure the path in app.json`);
+    }
+    const reversedClientId = getReversedClientId(googleServiceFilePath);
+    addUriScheme(config, reversedClientId);
+    return config;
+}
+exports.setUrlTypesForCaptcha = setUrlTypesForCaptcha;

package/plugin/src/index.ts

@@ -0,0 +1,16 @@
+import { ConfigPlugin, withPlugins, createRunOncePlugin } from '@expo/config-plugins';
+
+import { withIosCaptchaUrlTypes } from './ios';
+
+/**
+ * A config plugin for configuring `@react-native-firebase/auth`
+ */
+const withRnFirebaseAuth: ConfigPlugin = config => {
+  return withPlugins(config, [
+    // iOS
+    withIosCaptchaUrlTypes,
+  ]);
+};
+
+const pak = require('@react-native-firebase/auth/package.json');
+export default createRunOncePlugin(withRnFirebaseAuth, pak.name, pak.version);

package/plugin/src/ios/index.ts

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

package/plugin/src/ios/urlTypes.ts

@@ -0,0 +1,90 @@
+import {
+  ConfigPlugin,
+  IOSConfig,
+  withInfoPlist,
+  ExportedConfigWithProps,
+} from '@expo/config-plugins';
+import fs from 'fs';
+import path from 'path';
+import plist from 'plist';
+
+// 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 => {
+  return withInfoPlist(config, config => {
+    return setUrlTypesForCaptcha({ config });
+  });
+};
+
+function getReversedClientId(googleServiceFilePath: string): string {
+  try {
+    const googleServicePlist = fs.readFileSync(googleServiceFilePath, 'utf8');
+
+    const googleServiceJson = plist.parse(googleServicePlist) as { REVERSED_CLIENT_ID: string };
+    const REVERSED_CLIENT_ID = googleServiceJson.REVERSED_CLIENT_ID;
+
+    if (!REVERSED_CLIENT_ID) {
+      throw new TypeError('REVERSED_CLIENT_ID missing');
+    }
+
+    return REVERSED_CLIENT_ID;
+  } catch {
+    throw new Error(
+      '[@react-native-firebase/auth] Failed to parse your GoogleService-Info.plist. Are you sure it is a valid Info.Plist file with a REVERSE_CLIENT_ID field?',
+    );
+  }
+}
+
+// add phone auth support by configuring recaptcha
+// https://github.com/invertase/react-native-firebase/pull/6167
+function addUriScheme(
+  config: ExportedConfigWithProps<IOSConfig.InfoPlist>,
+  reversedClientId: string,
+): ExportedConfigWithProps<IOSConfig.InfoPlist> {
+  if (!config.modResults) {
+    config.modResults = {};
+  }
+
+  if (!config.modResults.CFBundleURLTypes) {
+    config.modResults.CFBundleURLTypes = [];
+  }
+
+  const hasReverseClientId = config.modResults.CFBundleURLTypes?.some(urlType =>
+    urlType.CFBundleURLSchemes.includes(reversedClientId),
+  );
+
+  if (!hasReverseClientId) {
+    config.modResults.CFBundleURLTypes.push({
+      CFBundleURLSchemes: [reversedClientId],
+    });
+  }
+
+  return config;
+}
+
+export function setUrlTypesForCaptcha({
+  config,
+}: {
+  config: ExportedConfigWithProps<IOSConfig.InfoPlist>;
+}) {
+  const googleServicesFileRelativePath = config.ios?.googleServicesFile;
+  if (!googleServicesFileRelativePath) {
+    throw new Error(
+      `[@react-native-firebase/auth] Your app.json file is missing ios.googleServicesFile. Please add this field.`,
+    );
+  }
+  const googleServiceFilePath = path.resolve(
+    config.modRequest.projectRoot,
+    googleServicesFileRelativePath,
+  );
+
+  if (!fs.existsSync(googleServiceFilePath)) {
+    throw new Error(
+      `[@react-native-firebase/auth] GoogleService-Info.plist doesn't exist in ${googleServiceFilePath}. Place it there or configure the path in app.json`,
+    );
+  }
+
+  const reversedClientId = getReversedClientId(googleServiceFilePath);
+  addUriScheme(config, reversedClientId);
+
+  return config;
+}

package/plugin/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "@tsconfig/node12/tsconfig.json",
+  "compilerOptions": {
+    "outDir": "build",
+    "rootDir": "src",
+    "declaration": true
+  },
+  "include": ["./src"]
+}