refactor(app-check)!: match AppCheck type with firebase-js-sdk

.github/scripts/compare-types/packages/app-check/app-check-sdk.d.ts

@@ -0,0 +1,248 @@
+/**
+ * The Firebase App Check Web SDK.
+ *
+ * @remarks
+ * Firebase App Check does not work in a Node.js environment using `ReCaptchaV3Provider` or
+ * `ReCaptchaEnterpriseProvider`, but can be used in Node.js if you use
+ * `CustomProvider` and write your own attestation method.
+ *
+ * @packageDocumentation
+ */
+
+import { FirebaseApp } from '@firebase/app';
+import { PartialObserver } from '@firebase/util';
+import { Unsubscribe } from '@firebase/util';
+
+/**
+ * The Firebase App Check service interface.
+ *
+ * @public
+ */
+export declare interface AppCheck {
+    /**
+     * The {@link @firebase/app#FirebaseApp} this `AppCheck` instance is associated with.
+     */
+    app: FirebaseApp;
+}
+
+/* Excluded from this release type: _AppCheckComponentName */
+
+/* Excluded from this release type: _AppCheckInternalComponentName */
+
+/**
+ * Options for App Check initialization.
+ * @public
+ */
+export declare interface AppCheckOptions {
+    /**
+     * A reCAPTCHA V3 provider, reCAPTCHA Enterprise provider, or custom provider.
+     */
+    provider: CustomProvider | ReCaptchaV3Provider | ReCaptchaEnterpriseProvider;
+    /**
+     * If set to true, enables automatic background refresh of App Check token.
+     */
+    isTokenAutoRefreshEnabled?: boolean;
+}
+
+declare interface AppCheckProvider {
+    /* Excluded from this release type: getToken */
+    /* Excluded from this release type: initialize */
+}
+
+/**
+ * The token returned from an App Check provider.
+ * @public
+ */
+export declare interface AppCheckToken {
+    readonly token: string;
+    /**
+     * The local timestamp after which the token will expire.
+     */
+    readonly expireTimeMillis: number;
+}
+
+declare interface AppCheckTokenInternal extends AppCheckToken {
+    issuedAtTimeMillis: number;
+}
+
+/**
+ * A listener that is called whenever the App Check token changes.
+ * @public
+ */
+export declare type AppCheckTokenListener = (token: AppCheckTokenResult) => void;
+
+/**
+ * Result returned by `getToken()`.
+ * @public
+ */
+export declare interface AppCheckTokenResult {
+    /**
+     * The token string in JWT format.
+     */
+    readonly token: string;
+}
+
+/**
+ * Custom provider class.
+ * @public
+ */
+export declare class CustomProvider implements AppCheckProvider {
+    private _customProviderOptions;
+    private _app?;
+    constructor(_customProviderOptions: CustomProviderOptions);
+    /* Excluded from this release type: getToken */
+    /* Excluded from this release type: initialize */
+    /* Excluded from this release type: isEqual */
+}
+
+/**
+ * Options when creating a {@link CustomProvider}.
+ * @public
+ */
+export declare interface CustomProviderOptions {
+    /**
+     * Function to get an App Check token through a custom provider
+     * service.
+     */
+    getToken: () => Promise<AppCheckToken>;
+}
+
+/**
+ * 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
+ * <a href="https://firebase.google.com/docs/app-check/custom-resource-backend#replay-protection">
+ * Replay Protection</a>. This method
+ * does not affect the token generation behavior of the
+ * #getAppCheckToken() method.
+ *
+ * @param appCheckInstance - The App Check service instance.
+ * @returns The limited use token.
+ * @public
+ */
+export declare function getLimitedUseToken(appCheckInstance: AppCheck): Promise<AppCheckTokenResult>;
+
+/**
+ * Get the current App Check token. If `forceRefresh` is false, this function first
+ * checks for a valid token in memory, then local persistence (IndexedDB).
+ * If not found, or if `forceRefresh` is true, it makes a request to the
+ * App Check endpoint for a fresh token. That request attaches
+ * to the most recent in-flight request if one is present.
+ *
+ * @param appCheckInstance - The App Check service instance.
+ * @param forceRefresh - If true, will always try to fetch a fresh token.
+ * If false, will use a cached token if found in storage.
+ * @public
+ */
+export declare function getToken(appCheckInstance: AppCheck, forceRefresh?: boolean): Promise<AppCheckTokenResult>;
+
+/**
+ * Activate App Check for the given app. Can be called only once per app.
+ * @param app - the {@link @firebase/app#FirebaseApp} to activate App Check for
+ * @param options - App Check initialization options
+ * @public
+ */
+export declare function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck;
+
+/**
+ * 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.
+ *
+ * @param appCheckInstance - The App Check service instance.
+ * @param observer - An object with `next`, `error`, and `complete`
+ * properties. `next` is called with an
+ * {@link AppCheckTokenResult}
+ * whenever the token changes. `error` is optional and is called if an
+ * error is thrown by the listener (the `next` function). `complete`
+ * is unused, as the token stream is unending.
+ *
+ * @returns A function that unsubscribes this listener.
+ * @public
+ */
+export declare function onTokenChanged(appCheckInstance: AppCheck, observer: PartialObserver<AppCheckTokenResult>): Unsubscribe;
+
+/**
+ * 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.
+ *
+ * @param appCheckInstance - The App Check service instance.
+ * @param onNext - When the token changes, this function is called with an
+ * {@link AppCheckTokenResult}.
+ * @param onError - Optional. Called if there is an error thrown by the
+ * listener (the `onNext` function).
+ * @param onCompletion - Currently unused, as the token stream is unending.
+ * @returns A function that unsubscribes this listener.
+ * @public
+ */
+export declare function onTokenChanged(appCheckInstance: AppCheck, onNext: (tokenResult: AppCheckTokenResult) => void, onError?: (error: Error) => void, onCompletion?: () => void): Unsubscribe;
+export { PartialObserver }
+
+/**
+ * App Check provider that can obtain a reCAPTCHA Enterprise token and exchange it
+ * for an App Check token.
+ *
+ * @public
+ */
+export declare class ReCaptchaEnterpriseProvider implements AppCheckProvider {
+    private _siteKey;
+    private _app?;
+    private _heartbeatServiceProvider?;
+    /**
+     * Throttle requests on certain error codes to prevent too many retries
+     * in a short time.
+     */
+    private _throttleData;
+    /**
+     * Create a ReCaptchaEnterpriseProvider instance.
+     * @param siteKey - reCAPTCHA Enterprise score-based site key.
+     */
+    constructor(_siteKey: string);
+    /* Excluded from this release type: getToken */
+    /* Excluded from this release type: initialize */
+    /* Excluded from this release type: isEqual */
+}
+
+/**
+ * App Check provider that can obtain a reCAPTCHA V3 token and exchange it
+ * for an App Check token.
+ *
+ * @public
+ */
+export declare class ReCaptchaV3Provider implements AppCheckProvider {
+    private _siteKey;
+    private _app?;
+    private _heartbeatServiceProvider?;
+    /**
+     * Throttle requests on certain error codes to prevent too many retries
+     * in a short time.
+     */
+    private _throttleData;
+    /**
+     * Create a ReCaptchaV3Provider instance.
+     * @param siteKey - ReCAPTCHA V3 siteKey.
+     */
+    constructor(_siteKey: string);
+    /* Excluded from this release type: getToken */
+    /* Excluded from this release type: initialize */
+    /* Excluded from this release type: isEqual */
+}
+
+/**
+ * Set whether App Check will automatically refresh tokens as needed.
+ *
+ * @param appCheckInstance - The App Check service instance.
+ * @param isTokenAutoRefreshEnabled - If true, the SDK automatically
+ * refreshes App Check tokens as needed. This overrides any value set
+ * during `initializeAppCheck()`.
+ * @public
+ */
+export declare function setTokenAutoRefreshEnabled(appCheckInstance: AppCheck, isTokenAutoRefreshEnabled: boolean): void;
+export { Unsubscribe }
+
+export { }

.github/scripts/compare-types/packages/app-check/config.ts

@@ -0,0 +1,102 @@
+/**
+ * Known differences between the firebase-js-sdk @firebase/app-check public
+ * API and the @react-native-firebase/app-check modular API.
+ *
+ * Each entry must have a `name` (the export name) and a `reason` explaining
+ * why the difference exists. Any difference NOT listed here will cause CI to
+ * fail so that new drift is caught and deliberately acknowledged.
+ */
+
+import type { PackageConfig } from '../../src/types';
+
+const config: PackageConfig = {
+  nameMapping: {},
+  missingInRN: [
+    {
+      name: 'AppCheckTokenListener',
+      reason:
+        'RN Firebase exposes token change listeners through the `onTokenChanged` overloads but does not export the standalone listener type alias from the firebase-js-sdk.',
+    },
+    {
+      name: 'PartialObserver',
+      reason:
+        'RN Firebase re-exports this type from `@react-native-firebase/app` common types rather than mirroring the firebase-js-sdk utility export directly.',
+    },
+    {
+      name: 'ReCaptchaEnterpriseProvider',
+      reason:
+        'Web-only reCAPTCHA Enterprise provider from the firebase-js-sdk. RN Firebase uses `ReactNativeFirebaseAppCheckProvider` to configure native platform providers instead.',
+    },
+    {
+      name: 'ReCaptchaV3Provider',
+      reason:
+        'Web-only reCAPTCHA v3 provider from the firebase-js-sdk. RN Firebase uses `ReactNativeFirebaseAppCheckProvider` for cross-platform provider configuration.',
+    },
+    {
+      name: 'Unsubscribe',
+      reason:
+        'RN Firebase re-exports this type from `@react-native-firebase/app` common types rather than mirroring the firebase-js-sdk utility export directly.',
+    },
+  ],
+  extraInRN: [
+    {
+      name: 'AppCheckProvider',
+      reason:
+        'RN Firebase keeps the provider interface public because its native and React Native-specific provider classes are part of the package surface.',
+    },
+    {
+      name: 'ReactNativeFirebaseAppCheckProviderOptions',
+      reason:
+        'RN Firebase-specific base options type used to configure native and React Native provider behavior across platforms.',
+    },
+    {
+      name: 'ReactNativeFirebaseAppCheckProviderWebOptions',
+      reason:
+        'RN Firebase-specific web provider config shape used by `ReactNativeFirebaseAppCheckProvider.configure()`.',
+    },
+    {
+      name: 'ReactNativeFirebaseAppCheckProviderAppleOptions',
+      reason:
+        'RN Firebase-specific Apple provider config shape used to select native iOS/macOS App Check providers.',
+    },
+    {
+      name: 'ReactNativeFirebaseAppCheckProviderAndroidOptions',
+      reason:
+        'RN Firebase-specific Android provider config shape used to select native Android App Check providers.',
+    },
+    {
+      name: 'ReactNativeFirebaseAppCheckProviderOptionsMap',
+      reason:
+        'RN Firebase-specific cross-platform provider options map used to configure Android, Apple, and web providers together.',
+    },
+    {
+      name: 'ReactNativeFirebaseAppCheckProviderConfig',
+      reason:
+        'RN Firebase convenience config object that allows provider options to be passed directly during initialization.',
+    },
+    {
+      name: 'ReactNativeFirebaseAppCheckProvider',
+      reason:
+        'RN Firebase-specific provider class that wraps native platform provider selection; there is no firebase-js-sdk equivalent export.',
+    },
+  ],
+  differentShape: [
+    {
+      name: 'initializeAppCheck',
+      reason:
+        'RN Firebase returns `Promise<AppCheck>` because App Check initialization crosses the native bridge, whereas the firebase-js-sdk returns `AppCheck` synchronously.',
+    },
+    {
+      name: 'AppCheckOptions',
+      reason:
+        'RN Firebase accepts `CustomProvider`, `ReactNativeFirebaseAppCheckProvider`, or a RN-specific provider config object instead of the firebase-js-sdk reCAPTCHA provider classes.',
+    },
+    {
+      name: 'CustomProvider',
+      reason:
+        'The RN Firebase `CustomProvider` class is tailored to the React Native/native initialization model, so its public class shape differs from the firebase-js-sdk version.',
+    },
+  ],
+};
+
+export default config;

.github/scripts/compare-types/src/registry.ts

@@ -14,6 +14,7 @@ import path from 'path';
 import type { PackageConfig } from './types';
 
 import aiConfig from '../packages/ai/config';
+import appCheckConfig from '../packages/app-check/config';
 import firestoreConfig from '../packages/firestore/config';
 import firestorePipelinesConfig from '../packages/firestore-pipelines/config';
 
@@ -109,6 +110,21 @@ export const packages: PackageEntry[] = [
     ],
     config: aiConfig,
   },
+  {
+    name: 'app-check',
+    firebaseSdkTypesPaths: [
+      path.join(SCRIPT_DIR, 'packages', 'app-check', 'app-check-sdk.d.ts'),
+    ],
+    rnFirebaseModularFiles: [
+      path.join(rnDist('app-check'), 'types', 'appcheck.d.ts'),
+      path.join(rnDist('app-check'), 'modular.d.ts'),
+    ],
+    rnFirebaseSupportFiles: [
+      path.join(rnDist('app-check'), 'providers.d.ts'),
+      path.join(rnDist('app-check'), 'types', 'internal.d.ts'),
+    ],
+    config: appCheckConfig,
+  },
   {
     name: 'firestore',
     firebaseSdkTypesPaths: [

.spellcheck.dict.txt

@@ -225,6 +225,7 @@ v6
 v7
 v9
 v22
+v25
 Ventura
 VertexAI
 VPN