@react-native-firebase/app-check 20.0.0 → 20.2.0

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.
 
+## [20.2.0](https://github.com/invertase/react-native-firebase/compare/v20.1.0...v20.2.0) (2024-07-15)
+
+### Features
+
+- **Other:** add App Check support ([#7905](https://github.com/invertase/react-native-firebase/issues/7905)) ([753b16e](https://github.com/invertase/react-native-firebase/commit/753b16e1a06f949c679fb75053c319394dd5ecfe))
+
+## [20.1.0](https://github.com/invertase/react-native-firebase/compare/v20.0.0...v20.1.0) (2024-06-04)
+
+**Note:** Version bump only for package @react-native-firebase/app-check
+
 ## [20.0.0](https://github.com/invertase/react-native-firebase/compare/v19.3.0...v20.0.0) (2024-05-20)
 
 **Note:** Version bump only for package @react-native-firebase/app-check

package/lib/index.d.ts

@@ -68,16 +68,30 @@ export namespace FirebaseAppCheckTypes {
     getToken(): Promise<AppCheckToken>;
   }
 
+  /**
+   * Custom provider class.
+   * @public
+   */
+  export class CustomProvider implements AppCheckProvider {
+    constructor(customProviderOptions: CustomProviderOptions);
+  }
+
+  export interface CustomProviderOptions {
+    /**
+     * Function to get an App Check token through a custom provider
+     * service.
+     */
+    getToken: () => Promise<AppCheckToken>;
+  }
   /**
    * Options for App Check initialization.
    */
   export interface AppCheckOptions {
     /**
-     * A reCAPTCHA V3 provider, reCAPTCHA Enterprise provider, or custom provider.
-     * Note that in react-native-firebase provider should always be ReactNativeAppCheckCustomProvider, a cross-platform
-     * implementation of an AppCheck CustomProvider
+     * The App Check provider to use. This can be either the built-in reCAPTCHA provider
+     * or a custom provider.
      */
-    provider: CustomProvider | ReCaptchaV3Provider | ReCaptchaEnterpriseProvider;
+    provider: CustomProvider;
 
     /**
      * If true, enables SDK to automatically
@@ -185,6 +199,7 @@ export namespace FirebaseAppCheckTypes {
   // eslint-disable-next-line @typescript-eslint/no-empty-interface
   export interface Statics {
     // firebase.appCheck.* static props go here
+    CustomProvider: typeof CustomProvider;
   }
 
   /**
@@ -210,18 +225,19 @@ export namespace FirebaseAppCheckTypes {
    */
   export class Module extends FirebaseModule {
     /**
-     * create a ReactNativeFirebaseAppCheckProvider option for use in react-native-firebase
+     * Create a ReactNativeFirebaseAppCheckProvider option for use in react-native-firebase
      */
     newReactNativeFirebaseAppCheckProvider(): ReactNativeFirebaseAppCheckProvider;
 
     /**
-     * initialize the AppCheck module. Note that in react-native-firebase AppCheckOptions must always
+     * Initialize the AppCheck module. Note that in react-native-firebase AppCheckOptions must always
      * be an object with a `provider` member containing `ReactNativeFirebaseAppCheckProvider` that has returned successfully
      * from a call to the `configure` method, with sub-providers for the various platforms configured to meet your project
      * requirements. This must be called prior to interacting with any firebase services protected by AppCheck
      *
      * @param options an AppCheckOptions with a configured ReactNativeFirebaseAppCheckProvider as the provider
      */
+    // TODO wrong types
     initializeAppCheck(options: AppCheckOptions): Promise<void>;
 
     /**
@@ -282,6 +298,7 @@ export namespace FirebaseAppCheckTypes {
      *
      * @returns A function that unsubscribes this listener.
      */
+    // TODO wrong types
     onTokenChanged(observer: PartialObserver<AppCheckListenerResult>): () => void;
 
     /**
@@ -301,6 +318,7 @@ export namespace FirebaseAppCheckTypes {
      *
      * @returns A function that unsubscribes this listener.
      */
+    // TODO wrong types
     onTokenChanged(
       onNext: (tokenResult: AppCheckListenerResult) => void,
       onError?: (error: Error) => void,

package/lib/index.js

@@ -15,7 +15,15 @@
  *
  */
 
-import { isBoolean, isIOS, isString } from '@react-native-firebase/app/lib/common';
+import {
+  isBoolean,
+  isIOS,
+  isString,
+  isObject,
+  isFunction,
+  isUndefined,
+  isOther,
+} from '@react-native-firebase/app/lib/common';
 import {
   createModuleNamespace,
   FirebaseModule,
@@ -23,6 +31,8 @@ import {
 } from '@react-native-firebase/app/lib/internal';
 import { Platform } from 'react-native';
 import ReactNativeFirebaseAppCheckProvider from './ReactNativeFirebaseAppCheckProvider';
+import { setReactNativeModule } from '@react-native-firebase/app/lib/internal/nativeModule';
+import fallBackModule from './web/RNFBAppCheckModule';
 
 import version from './version';
 
@@ -34,12 +44,30 @@ export {
   setTokenAutoRefreshEnabled,
 } from './modular/index';
 
-const statics = {};
-
 const namespace = 'appCheck';
 
 const nativeModuleName = 'RNFBAppCheckModule';
 
+export class CustomProvider {
+  constructor(_customProviderOptions) {
+    if (!isObject(_customProviderOptions)) {
+      throw new Error('Invalid configuration: no provider options defined.');
+    }
+    if (!isFunction(_customProviderOptions.getToken)) {
+      throw new Error('Invalid configuration: no getToken function defined.');
+    }
+    this._customProviderOptions = _customProviderOptions;
+  }
+
+  async getToken() {
+    return this._customProviderOptions.getToken();
+  }
+}
+
+const statics = {
+  CustomProvider,
+};
+
 class FirebaseAppCheckModule extends FirebaseModule {
   constructor(...args) {
     super(...args);
@@ -63,6 +91,15 @@ class FirebaseAppCheckModule extends FirebaseModule {
   }
 
   initializeAppCheck(options) {
+    if (isOther) {
+      if (!isObject(options)) {
+        throw new Error('Invalid configuration: no options defined.');
+      }
+      if (isUndefined(options.provider)) {
+        throw new Error('Invalid configuration: no provider defined.');
+      }
+      return this.native.initializeAppCheck(options);
+    }
     // determine token refresh setting, if not specified
     if (!isBoolean(options.isTokenAutoRefreshEnabled)) {
       options.isTokenAutoRefreshEnabled = this.firebaseJson.app_check_token_auto_refresh;
@@ -108,6 +145,9 @@ class FirebaseAppCheckModule extends FirebaseModule {
   }
 
   activate(siteKeyOrProvider, isTokenAutoRefreshEnabled) {
+    if (isOther) {
+      throw new Error('firebase.appCheck().activate(*) is not supported on other platforms');
+    }
     if (!isString(siteKeyOrProvider)) {
       throw new Error('siteKeyOrProvider must be a string value to match firebase-js-sdk API');
     }
@@ -130,6 +170,7 @@ class FirebaseAppCheckModule extends FirebaseModule {
     return this.initializeAppCheck({ provider: rnfbProvider, isTokenAutoRefreshEnabled });
   }
 
+  // TODO this is an async call
   setTokenAutoRefreshEnabled(isTokenAutoRefreshEnabled) {
     this.native.setTokenAutoRefreshEnabled(isTokenAutoRefreshEnabled);
   }
@@ -203,3 +244,6 @@ export default createModuleNamespace({
 // appCheck().X(...);
 // firebase.appCheck().X(...);
 export const firebase = getFirebaseRoot();
+
+// Register the interop module for non-native platforms.
+setReactNativeModule(nativeModuleName, fallBackModule);

package/lib/version.js

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

package/lib/web/RNFBAppCheckModule.android.js

@@ -0,0 +1,2 @@
+// No-op for android.
+export default {};

package/lib/web/RNFBAppCheckModule.ios.js

@@ -0,0 +1,2 @@
+// No-op for ios.
+export default {};

package/lib/web/RNFBAppCheckModule.js

@@ -0,0 +1,95 @@
+import {
+  getApp,
+  initializeAppCheck,
+  getToken,
+  getLimitedUseToken,
+  setTokenAutoRefreshEnabled,
+  CustomProvider,
+  onTokenChanged,
+  makeIDBAvailable,
+} from '@react-native-firebase/app/lib/internal/web/firebaseAppCheck';
+import { guard, emitEvent } from '@react-native-firebase/app/lib/internal/web/utils';
+
+let appCheckInstances = {};
+let listenersForApp = {};
+
+function getAppCheckInstanceForApp(appName) {
+  if (!appCheckInstances[appName]) {
+    throw new Error(
+      `firebase AppCheck instance for app ${appName} has not been initialized, ensure you have called initializeAppCheck() first.`,
+    );
+  }
+  return appCheckInstances[appName];
+}
+
+/**
+ * This is a 'NativeModule' for the web platform.
+ * Methods here are identical to the ones found in
+ * the native android/ios modules e.g. `@ReactMethod` annotated
+ * java methods on Android.
+ */
+export default {
+  initializeAppCheck(appName, options) {
+    makeIDBAvailable();
+    return guard(async () => {
+      if (appCheckInstances[appName]) {
+        return;
+      }
+      const { provider, isTokenAutoRefreshEnabled } = options;
+      const _provider = new CustomProvider({
+        getToken() {
+          return provider.getToken();
+        },
+      });
+      appCheckInstances[appName] = initializeAppCheck(getApp(appName), {
+        provider: _provider,
+        isTokenAutoRefreshEnabled,
+      });
+      return null;
+    });
+  },
+  setTokenAutoRefreshEnabled(appName, isTokenAutoRefreshEnabled) {
+    return guard(async () => {
+      const instance = getAppCheckInstanceForApp(appName);
+      setTokenAutoRefreshEnabled(instance, isTokenAutoRefreshEnabled);
+      return null;
+    });
+  },
+  getLimitedUseToken(appName) {
+    return guard(async () => {
+      const instance = getAppCheckInstanceForApp(appName);
+      return getLimitedUseToken(instance);
+    });
+  },
+  getToken(appName, forceRefresh) {
+    return guard(async () => {
+      const instance = getAppCheckInstanceForApp(appName);
+      return getToken(instance, forceRefresh);
+    });
+  },
+  addAppCheckListener(appName) {
+    return guard(async () => {
+      if (listenersForApp[appName]) {
+        return;
+      }
+      const instance = getAppCheckInstanceForApp(appName);
+      listenersForApp[appName] = onTokenChanged(instance, tokenResult => {
+        emitEvent('appCheck_token_changed', {
+          appName,
+          ...tokenResult,
+        });
+      });
+      return null;
+    });
+  },
+  removeAppCheckListener(appName) {
+    return guard(async () => {
+      if (!listenersForApp[appName]) {
+        return;
+      }
+      listenersForApp[appName]();
+      delete listenersForApp[appName];
+      return null;
+    });
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/app-check",
-  "version": "20.0.0",
+  "version": "20.2.0",
   "author": "Invertase <oss@invertase.io> (http://invertase.io)",
   "description": "React Native Firebase - App Check",
   "main": "lib/index.js",
@@ -25,11 +25,11 @@
     "appCheck"
   ],
   "peerDependencies": {
-    "@react-native-firebase/app": "20.0.0",
+    "@react-native-firebase/app": "20.2.0",
     "expo": ">=47.0.0"
   },
   "devDependencies": {
-    "expo": "^50.0.18"
+    "expo": "^50.0.19"
   },
   "peerDependenciesMeta": {
     "expo": {
@@ -39,5 +39,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b6079dd09ed1f6e47dc782df0d98c5479bfc0cd4"
+  "gitHead": "82c50138d07e673213cd8dee5ce9a2f9b5656649"
 }

package/type-test.ts

@@ -1,4 +1,6 @@
-import firebase  from '.';
+import firebase from '.';
+
+// TODO none of these seem to work, local issue?
 
 // checks module exists at root
 console.log(firebase.appCheck().app.name);