@react-native-firebase/app-check 24.1.1 → 25.0.1

package/lib/namespaced.ts

@@ -20,7 +20,6 @@ import {
   isIOS,
   isString,
   isObject,
-  isFunction,
   isUndefined,
   isOther,
   parseListenerOrObserver,
@@ -32,45 +31,24 @@ import {
 } from '@react-native-firebase/app/dist/module/internal';
 import type { ModuleConfig } from '@react-native-firebase/app/dist/module/internal';
 import { Platform } from 'react-native';
-import ReactNativeFirebaseAppCheckProvider from './ReactNativeFirebaseAppCheckProvider';
 import { setReactNativeModule } from '@react-native-firebase/app/dist/module/internal/nativeModule';
 import fallBackModule from './web/RNFBAppCheckModule';
 import { version } from './version';
 import type {
-  CustomProviderOptions,
+  AppCheckOptions,
   AppCheckProvider,
   AppCheckTokenResult,
-  AppCheckOptions,
-  AppCheckListenerResult,
   PartialObserver,
-  AppCheck,
-  AppCheckStatics,
-  ProviderWithOptions,
 } from './types/appcheck';
+import type { ProviderWithOptions } from './types/internal';
+import type { FirebaseAppCheckTypes } from './types/namespaced';
 import type { ReactNativeFirebase } from '@react-native-firebase/app';
+import { CustomProvider, ReactNativeFirebaseAppCheckProvider } from './providers';
 
 const namespace = 'appCheck';
 
 const nativeModuleName = 'RNFBAppCheckModule';
 
-export class CustomProvider implements AppCheckProvider {
-  private _customProviderOptions: CustomProviderOptions;
-
-  constructor(_customProviderOptions: 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,
 };
@@ -89,7 +67,7 @@ function hasProviderOptions(
   );
 }
 
-class FirebaseAppCheckModule extends FirebaseModule {
+class FirebaseAppCheckModule extends FirebaseModule<typeof nativeModuleName> {
   _listenerCount: number;
 
   constructor(
@@ -226,8 +204,8 @@ class FirebaseAppCheckModule extends FirebaseModule {
 
   onTokenChanged(
     onNextOrObserver:
-      | PartialObserver<AppCheckListenerResult>
-      | ((tokenResult: AppCheckListenerResult) => void),
+      | PartialObserver<FirebaseAppCheckTypes.AppCheckListenerResult>
+      | ((tokenResult: FirebaseAppCheckTypes.AppCheckListenerResult) => void),
     _onError?: (error: Error) => void,
     _onCompletion?: () => void,
   ): () => void {
@@ -239,8 +217,8 @@ class FirebaseAppCheckModule extends FirebaseModule {
     }
     const nextFn = parseListenerOrObserver(
       onNextOrObserver as
-        | ((value: AppCheckListenerResult) => void)
-        | { next: (value: AppCheckListenerResult) => void },
+        | ((value: FirebaseAppCheckTypes.AppCheckListenerResult) => void)
+        | { next: (value: FirebaseAppCheckTypes.AppCheckListenerResult) => void },
     );
     // let errorFn = function () { };
     // if (onNextOrObserver.error != null) {
@@ -278,10 +256,13 @@ const appCheckNamespace = createModuleNamespace({
 });
 
 type AppCheckNamespace = ReactNativeFirebase.FirebaseModuleWithStaticsAndApp<
-  AppCheck,
-  AppCheckStatics
+  FirebaseAppCheckTypes.Module,
+  FirebaseAppCheckTypes.Statics
 > & {
-  appCheck: ReactNativeFirebase.FirebaseModuleWithStaticsAndApp<AppCheck, AppCheckStatics>;
+  appCheck: ReactNativeFirebase.FirebaseModuleWithStaticsAndApp<
+    FirebaseAppCheckTypes.Module,
+    FirebaseAppCheckTypes.Statics
+  >;
   firebase: ReactNativeFirebase.Module;
   app(name?: string): ReactNativeFirebase.FirebaseApp;
 };
@@ -296,8 +277,8 @@ export default appCheckNamespace as unknown as AppCheckNamespace;
 export const firebase =
   getFirebaseRoot() as unknown as ReactNativeFirebase.FirebaseNamespacedExport<
     'appCheck',
-    AppCheck,
-    AppCheckStatics,
+    FirebaseAppCheckTypes.Module,
+    FirebaseAppCheckTypes.Statics,
     false
   >;
 

package/lib/providers.ts

@@ -0,0 +1,49 @@
+import type {
+  AppCheckProvider,
+  AppCheckToken,
+  CustomProviderOptions,
+  ReactNativeFirebaseAppCheckProviderOptionsMap as ProviderOptions,
+} from './types/appcheck';
+import { isFunction, isObject } from '@react-native-firebase/app/dist/module/common';
+
+/**
+ * @public Use this to configure providers for android, iOS and "other" platforms.
+ */
+export class ReactNativeFirebaseAppCheckProvider implements AppCheckProvider {
+  providerOptions?: ProviderOptions;
+
+  constructor(options?: ProviderOptions) {
+    this.providerOptions = options;
+  }
+
+  configure(options: ProviderOptions): void {
+    this.providerOptions = options;
+  }
+
+  async getToken(): Promise<AppCheckToken> {
+    // This is a placeholder - the actual implementation is handled by the native modules
+    // This method exists to satisfy the AppCheckProvider interface
+    throw new Error('getToken() must be called after configure() and is handled by native modules');
+  }
+}
+
+/**
+ * @public Use this to configure a Custom Provider on "other" platform. This will not work on iOS and android.
+ */
+export class CustomProvider implements AppCheckProvider {
+  private _customProviderOptions: CustomProviderOptions;
+
+  constructor(_customProviderOptions: 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();
+  }
+}

package/lib/types/appcheck.ts

@@ -15,42 +15,43 @@
  *
  */
 
-import type { ReactNativeFirebase } from '@react-native-firebase/app';
-
-// ============ Provider Types ============
+import type { FirebaseApp } from '@react-native-firebase/app';
+import type { CustomProvider, ReactNativeFirebaseAppCheckProvider } from '../providers';
 
+export type {
+  Unsubscribe,
+  PartialObserver,
+} from '@react-native-firebase/app/dist/module/types/common';
 /**
- * An App Check provider. This can be either the built-in reCAPTCHA provider
- * or a custom provider. For more on custom providers, see
- * https://firebase.google.com/docs/app-check/web-custom-provider
+ * The Firebase App Check service interface.
+ *
+ * @public
  */
-export interface AppCheckProvider {
+export interface AppCheck {
   /**
-   * Returns an AppCheck token.
+   *  this `AppCheck` instance is associated with this FirebaseApp.
    */
-  getToken(): Promise<AppCheckToken>;
-}
-
-/**
- * Function to get an App Check token through a custom provider service.
- */
-export interface CustomProviderOptions {
-  getToken: () => Promise<AppCheckToken>;
+  app: FirebaseApp;
 }
 
-// ============ Options & Result Types ============
-
 /**
- * Custom provider class.
+ * The token returned from an `AppCheckProvider`.
  * @public
  */
-export declare class CustomProvider implements AppCheckProvider {
-  constructor(customProviderOptions: CustomProviderOptions);
-  getToken(): Promise<AppCheckToken>;
+export interface AppCheckToken {
+  /**
+   * The token string in JWT format.
+   */
+  readonly token: string;
+  /**
+   * The local timestamp after which the token will expire.
+   */
+  readonly expireTimeMillis: number;
 }
 
 /**
  * Options for App Check initialization.
+ * @public
  */
 export interface AppCheckOptions {
   /**
@@ -73,21 +74,21 @@ export interface AppCheckOptions {
 }
 
 /**
- * The token returned from an `AppCheckProvider`.
+ * Function to get an App Check token through a custom provider service. This is for
+ * "other" platform only, this is not supported on iOS and android.
+ * @public
  */
-export interface AppCheckToken {
-  /**
-   * The token string in JWT format.
-   */
-  readonly token: string;
+export interface CustomProviderOptions {
   /**
-   * The local timestamp after which the token will expire.
+   * Function to get an App Check token through a custom provider
+   * service.
    */
-  readonly expireTimeMillis: number;
+  getToken: () => Promise<AppCheckToken>;
 }
 
 /**
  * Result returned by `getToken()`.
+ * @public
  */
 export interface AppCheckTokenResult {
   /**
@@ -97,31 +98,22 @@ export interface AppCheckTokenResult {
 }
 
 /**
- * The result return from `onTokenChanged`
+ * An App Check provider. This can be either the built-in reCAPTCHA provider
+ * or a custom provider. For more on custom providers, see
+ * https://firebase.google.com/docs/app-check/web-custom-provider
+ * @public
  */
-export type AppCheckListenerResult = AppCheckToken & { readonly appName: string };
-
-// ============ Observer Types ============
-
-export type NextFn<T> = (value: T) => void;
-export type ErrorFn = (error: Error) => void;
-export type CompleteFn = () => void;
-
-export interface Observer<T> {
-  next: NextFn<T>;
-  error: ErrorFn;
-  complete: CompleteFn;
+export interface AppCheckProvider {
+  /**
+   * Returns an AppCheck token.
+   */
+  getToken(): Promise<AppCheckToken>;
 }
 
-export type PartialObserver<T> = Partial<Observer<T>>;
-
 /**
- * A function that unsubscribes from token changes.
+ * Options for ReactNativeFirebaseAppCheckProvider.
+ * @public
  */
-export type Unsubscribe = () => void;
-
-// ============ ReactNativeFirebaseAppCheckProvider Types ============
-
 export interface ReactNativeFirebaseAppCheckProviderOptions {
   /**
    * debug token to use, if any. Defaults to undefined, pre-configure tokens in firebase web console if needed
@@ -129,6 +121,10 @@ export interface ReactNativeFirebaseAppCheckProviderOptions {
   debugToken?: string;
 }
 
+/**
+ * Options for ReactNativeFirebaseAppCheckProvider on web.
+ * @public
+ */
 export interface ReactNativeFirebaseAppCheckProviderWebOptions extends ReactNativeFirebaseAppCheckProviderOptions {
   /**
    * The web provider to use, either `reCaptchaV3` or `reCaptchaEnterprise`, defaults to `reCaptchaV3`
@@ -141,6 +137,10 @@ export interface ReactNativeFirebaseAppCheckProviderWebOptions extends ReactNati
   siteKey?: string;
 }
 
+/**
+ * Options for ReactNativeFirebaseAppCheckProvider on apple.
+ * @public
+ */
 export interface ReactNativeFirebaseAppCheckProviderAppleOptions extends ReactNativeFirebaseAppCheckProviderOptions {
   /**
    * The apple provider to use, either `deviceCheck` or `appAttest`, or `appAttestWithDeviceCheckFallback`,
@@ -150,6 +150,10 @@ export interface ReactNativeFirebaseAppCheckProviderAppleOptions extends ReactNa
   provider?: 'debug' | 'deviceCheck' | 'appAttest' | 'appAttestWithDeviceCheckFallback';
 }
 
+/**
+ * Options for ReactNativeFirebaseAppCheckProvider on android.
+ * @public
+ */
 export interface ReactNativeFirebaseAppCheckProviderAndroidOptions extends ReactNativeFirebaseAppCheckProviderOptions {
   /**
    * The android provider to use, either `debug` or `playIntegrity`. default is `playIntegrity`.
@@ -159,6 +163,7 @@ export interface ReactNativeFirebaseAppCheckProviderAndroidOptions extends React
 
 /**
  * Platform-specific provider options configuration.
+ * @public
  */
 export type ReactNativeFirebaseAppCheckProviderOptionsMap = {
   web?: ReactNativeFirebaseAppCheckProviderWebOptions;
@@ -172,215 +177,8 @@ export type ReactNativeFirebaseAppCheckProviderOptionsMap = {
  * that can be passed directly with providerOptions (for convenience in initialization).
  * The runtime accepts objects with providerOptions even if they don't have
  * getToken() and configure() methods.
+ * @public
  */
 export interface ReactNativeFirebaseAppCheckProviderConfig {
   providerOptions: ReactNativeFirebaseAppCheckProviderOptionsMap;
 }
-
-export interface ReactNativeFirebaseAppCheckProvider extends AppCheckProvider {
-  /**
-   * Provider options for platform-specific configuration.
-   * This is set when configure() is called.
-   */
-  providerOptions?: ReactNativeFirebaseAppCheckProviderOptionsMap;
-
-  /**
-   * Specify how the app check provider should be configured. The new configuration is
-   * in effect when this call returns. You must call `getToken()`
-   * after this call to get a token using the new configuration.
-   * This custom provider allows for delayed configuration and re-configuration on all platforms
-   * so AppCheck has the same experience across all platforms, with the only difference being the native
-   * providers you choose to use on each platform.
-   */
-  configure(options: ReactNativeFirebaseAppCheckProviderOptionsMap): void;
-}
-
-/**
- * Type representing providers that have providerOptions.
- * Used for type narrowing in runtime code.
- */
-export type ProviderWithOptions =
-  | ReactNativeFirebaseAppCheckProvider
-  | ReactNativeFirebaseAppCheckProviderConfig;
-
-// ============ Module Interface ============
-
-/**
- * App Check module instance - returned from firebase.appCheck() or firebase.app().appCheck()
- */
-export interface AppCheck extends ReactNativeFirebase.FirebaseModule {
-  /** The FirebaseApp this module is associated with */
-  app: ReactNativeFirebase.FirebaseApp;
-
-  /**
-   * 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
-   * 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
-   */
-  initializeAppCheck(options: AppCheckOptions): Promise<void>;
-
-  /**
-   * Activate App Check
-   * On iOS App Check is activated with DeviceCheck provider simply by including the module, using the token auto refresh default or
-   * the specific value (if configured) in firebase.json, but calling this does no harm.
-   * On Android if you call this it will install the PlayIntegrity provider in release builds, the Debug provider if debuggable.
-   * On both platforms you may use this method to alter the token refresh setting after startup.
-   * On iOS if you want to set a specific AppCheckProviderFactory (for instance to FIRAppCheckDebugProviderFactory or
-   * FIRAppAttestProvider) you must manually do that in your AppDelegate.m prior to calling [FIRApp configure]
-   *
-   * @deprecated use initializeAppCheck to gain access to all platform providers and firebase-js-sdk v9 compatibility
-   * @param siteKeyOrProvider - This is ignored, Android uses DebugProviderFactory if the app is debuggable (https://firebase.google.com/docs/app-check/android/debug-provider)
-   *                            Android uses PlayIntegrityProviderFactory for release builds.
-   *                            iOS uses DeviceCheckProviderFactory by default unless altered in AppDelegate.m manually
-   * @param isTokenAutoRefreshEnabled - If true, enables SDK to automatically
-   * refresh AppCheck token as needed. If undefined, the value will default
-   * to the value of `app.automaticDataCollectionEnabled`. That property
-   * defaults to false and can be set in the app config.
-   */
-  activate(
-    siteKeyOrProvider: string | AppCheckProvider,
-    isTokenAutoRefreshEnabled?: boolean,
-  ): Promise<void>;
-
-  /**
-   * Alter the token auto refresh setting. By default it will take the value of automaticDataCollectionEnabled from Info.plist / AndroidManifest.xml
-   * @param isTokenAutoRefreshEnabled - If true, the SDK automatically
-   * refreshes App Check tokens as needed. This overrides any value set
-   * during `activate()` or taken by default from automaticDataCollectionEnabled in plist / android manifest
-   */
-  setTokenAutoRefreshEnabled(isTokenAutoRefreshEnabled: boolean): void;
-
-  /**
-   * Requests Firebase App Check token.
-   * This method should only be used if you need to authorize requests to a non-Firebase backend.
-   * Requests to Firebase backend are authorized automatically if configured.
-   *
-   * @param forceRefresh - If true, a new Firebase App Check token is requested and the token cache is ignored.
-   * If false, the cached token is used if it exists and has not expired yet.
-   * In most cases, false should be used. True should only be used if the server explicitly returns an error, indicating a revoked token.
-   */
-  getToken(forceRefresh?: boolean): Promise<AppCheckTokenResult>;
-
-  /**
-   * Requests a Firebase App Check token. This method should be used only if you need to authorize requests
-   * to a non-Firebase backend. Returns limited-use tokens that are intended for use with your non-Firebase
-   * backend endpoints that are protected with Replay Protection (https://firebase.google.com/docs/app-check/custom-resource-backend#replay-protection).
-   * This method does not affect the token generation behavior of the getAppCheckToken() method.
-   */
-  getLimitedUseToken(): Promise<AppCheckTokenResult>;
-
-  /**
-   * Registers a listener to changes in the token state. There can be more
-   * than one listener registered at the same time for one or more
-   * App Check instances. The listeners call back on the UI thread whenever
-   * the current token associated with this App Check instance changes.
-   *
-   * @returns A function that unsubscribes this listener.
-   */
-  onTokenChanged(observer: PartialObserver<AppCheckListenerResult>): () => void;
-
-  /**
-   * Registers a listener to changes in the token state. There can be more
-   * than one listener registered at the same time for one or more
-   * App Check instances. The listeners call back on the UI thread whenever
-   * the current token associated with this App Check instance changes.
-   *
-   * Token listeners do not exist in the native SDK for iOS, no token change events will be emitted on that platform.
-   * This is not yet implemented on Android, no token change events will be emitted until implemented.
-   *
-   * NOTE: Although an `onError` callback can be provided, it will
-   * never be called, Android sdk code doesn't provide handling for onError function
-   *
-   * NOTE: Although an `onCompletion` callback can be provided, it will
-   * never be called because the token stream is never-ending.
-   *
-   * @returns A function that unsubscribes this listener.
-   */
-  onTokenChanged(
-    onNext: (tokenResult: AppCheckListenerResult) => void,
-    onError?: (error: Error) => void,
-    onCompletion?: () => void,
-  ): () => void;
-}
-
-// ============ Statics Interface ============
-
-/**
- * Static properties available on firebase.appCheck
- */
-export interface AppCheckStatics {
-  CustomProvider: new (customProviderOptions: CustomProviderOptions) => CustomProvider;
-  SDK_VERSION: string;
-}
-
-/**
- * FirebaseApp type with appCheck() method.
- * @deprecated Import FirebaseApp from '@react-native-firebase/app' instead.
- * The appCheck() method is added via module augmentation.
- */
-export type FirebaseApp = ReactNativeFirebase.FirebaseApp;
-
-// ============ Module Augmentation ============
-
-/* eslint-disable @typescript-eslint/no-namespace */
-declare module '@react-native-firebase/app' {
-  namespace ReactNativeFirebase {
-    interface Module {
-      appCheck: FirebaseModuleWithStaticsAndApp<AppCheck, AppCheckStatics>;
-    }
-    interface FirebaseApp {
-      appCheck(): AppCheck;
-    }
-  }
-}
-/* eslint-enable @typescript-eslint/no-namespace */
-
-// ============ Backwards Compatibility Namespace ============
-
-// Helper types to reference outer scope types within the namespace
-// These are needed because TypeScript can't directly alias types with the same name
-type _AppCheckProvider = AppCheckProvider;
-type _CustomProviderOptions = CustomProviderOptions;
-type _AppCheckOptions = AppCheckOptions;
-type _AppCheckToken = AppCheckToken;
-type _AppCheckTokenResult = AppCheckTokenResult;
-type _AppCheckListenerResult = AppCheckListenerResult;
-type _AppCheck = AppCheck;
-type _AppCheckStatics = AppCheckStatics;
-
-/**
- * @deprecated Use the exported types directly instead.
- * FirebaseAppCheckTypes namespace is kept for backwards compatibility.
- */
-/* eslint-disable @typescript-eslint/no-namespace */
-export namespace FirebaseAppCheckTypes {
-  // Short name aliases referencing top-level types
-  export type Provider = AppCheckProvider;
-  export type ProviderOptions = CustomProviderOptions;
-  export type Options = AppCheckOptions;
-  export type Token = AppCheckToken;
-  export type TokenResult = AppCheckTokenResult;
-  export type ListenerResult = AppCheckListenerResult;
-  export type Statics = AppCheckStatics;
-  export type Module = AppCheck;
-
-  // AppCheck* aliases that reference the exported types above via helper types
-  // These provide backwards compatibility for code using FirebaseAppCheckTypes.AppCheckProvider
-  export type AppCheckProvider = _AppCheckProvider;
-  export type CustomProviderOptions = _CustomProviderOptions;
-  export type AppCheckOptions = _AppCheckOptions;
-  export type AppCheckToken = _AppCheckToken;
-  export type AppCheckTokenResult = _AppCheckTokenResult;
-  export type AppCheckListenerResult = _AppCheckListenerResult;
-  export type AppCheck = _AppCheck;
-  export type AppCheckStatics = _AppCheckStatics;
-}
-/* eslint-enable @typescript-eslint/no-namespace */