@react-native-firebase/app-check 23.7.0 → 23.8.1

package/lib/web/RNFBAppCheckModule.ios.ts

@@ -0,0 +1,4 @@
+// No-op for ios.
+const module: Record<string, never> = {};
+
+export default module;

package/lib/web/RNFBAppCheckModule.ts

@@ -0,0 +1,115 @@
+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';
+import type { FirebaseAppCheckTypes } from '../types/appcheck';
+
+let appCheckInstances: Record<string, any> = {};
+let listenersForApp: Record<string, () => void> = {};
+
+function getAppCheckInstanceForApp(appName: string): any {
+  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];
+}
+
+interface AppCheckModule {
+  initializeAppCheck(
+    appName: string,
+    options: FirebaseAppCheckTypes.AppCheckOptions,
+  ): Promise<void>;
+  setTokenAutoRefreshEnabled(appName: string, isTokenAutoRefreshEnabled: boolean): Promise<void>;
+  getLimitedUseToken(appName: string): Promise<FirebaseAppCheckTypes.AppCheckTokenResult>;
+  getToken(
+    appName: string,
+    forceRefresh: boolean,
+  ): Promise<FirebaseAppCheckTypes.AppCheckTokenResult>;
+  addAppCheckListener(appName: string): Promise<void>;
+  removeAppCheckListener(appName: string): Promise<void>;
+}
+
+/**
+ * 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.
+ */
+const module: AppCheckModule = {
+  initializeAppCheck(appName: string, options: FirebaseAppCheckTypes.AppCheckOptions) {
+    makeIDBAvailable();
+    return guard(async () => {
+      if (appCheckInstances[appName]) {
+        return;
+      }
+      const { provider, isTokenAutoRefreshEnabled } = options;
+      const _provider = new CustomProvider({
+        getToken() {
+          if ('getToken' in provider && typeof provider.getToken === 'function') {
+            return provider.getToken();
+          }
+          throw new Error('Provider does not have a getToken method');
+        },
+      });
+      appCheckInstances[appName] = initializeAppCheck(getApp(appName), {
+        provider: _provider,
+        isTokenAutoRefreshEnabled,
+      });
+    });
+  },
+  setTokenAutoRefreshEnabled(appName: string, isTokenAutoRefreshEnabled: boolean) {
+    return guard(async () => {
+      const instance = getAppCheckInstanceForApp(appName);
+      setTokenAutoRefreshEnabled(instance, isTokenAutoRefreshEnabled);
+    });
+  },
+  getLimitedUseToken(appName: string) {
+    return guard(async () => {
+      const instance = getAppCheckInstanceForApp(appName);
+      return getLimitedUseToken(instance);
+    });
+  },
+  getToken(appName: string, forceRefresh: boolean) {
+    return guard(async () => {
+      const instance = getAppCheckInstanceForApp(appName);
+      return getToken(instance, forceRefresh);
+    });
+  },
+  addAppCheckListener(appName: string) {
+    return guard(async () => {
+      if (listenersForApp[appName]) {
+        return;
+      }
+      const instance = getAppCheckInstanceForApp(appName);
+      listenersForApp[appName] = onTokenChanged(
+        instance,
+        (tokenResult: FirebaseAppCheckTypes.AppCheckTokenResult) => {
+          emitEvent('appCheck_token_changed', {
+            appName,
+            ...tokenResult,
+          });
+        },
+      );
+    });
+  },
+  removeAppCheckListener(appName: string) {
+    return guard(async () => {
+      if (!listenersForApp[appName]) {
+        return;
+      }
+      listenersForApp[appName]();
+      delete listenersForApp[appName];
+    });
+  },
+};
+
+export default module;

package/package.json

@@ -1,16 +1,18 @@
 {
   "name": "@react-native-firebase/app-check",
-  "version": "23.7.0",
+  "version": "23.8.1",
   "author": "Invertase <oss@invertase.io> (http://invertase.io)",
   "description": "React Native Firebase - App Check",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "main": "./dist/commonjs/index.js",
+  "module": "./dist/module/index.js",
+  "types": "./dist/typescript/commonjs/lib/index.d.ts",
   "scripts": {
-    "build": "genversion --semi lib/version.js",
+    "build": "genversion --esm --semi lib/version.ts",
     "build:clean": "rimraf android/build && rimraf ios/build",
     "build:plugin": "rimraf plugin/build && tsc --build plugin",
     "lint:plugin": "eslint plugin/src/*",
-    "prepare": "yarn run build && yarn run build:plugin"
+    "compile": "bob build",
+    "prepare": "yarn run build && yarn compile && yarn run build:plugin"
   },
   "repository": {
     "type": "git",
@@ -25,11 +27,13 @@
     "appCheck"
   ],
   "peerDependencies": {
-    "@react-native-firebase/app": "23.7.0",
+    "@react-native-firebase/app": "23.8.1",
     "expo": ">=47.0.0"
   },
   "devDependencies": {
-    "expo": "^54.0.27"
+    "expo": "^54.0.27",
+    "react-native-builder-bob": "^0.40.17",
+    "typescript": "^5.9.3"
   },
   "peerDependenciesMeta": {
     "expo": {
@@ -40,5 +44,47 @@
     "access": "public",
     "provenance": true
   },
-  "gitHead": "2a30c0b1e41a2b239172afd167f98a03fd422f2c"
+  "exports": {
+    ".": {
+      "source": "./lib/index.ts",
+      "import": {
+        "types": "./dist/typescript/module/lib/index.d.ts",
+        "default": "./dist/module/index.js"
+      },
+      "require": {
+        "types": "./dist/typescript/commonjs/lib/index.d.ts",
+        "default": "./dist/commonjs/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "react-native-builder-bob": {
+    "source": "lib",
+    "output": "dist",
+    "targets": [
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "commonjs",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "tsc": "../../node_modules/.bin/tsc"
+        }
+      ]
+    ]
+  },
+  "eslintIgnore": [
+    "node_modules/",
+    "dist/"
+  ],
+  "gitHead": "46b06d2b1100ec03c7807b4ff34b583b773a19d7"
 }

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "extends": "../../tsconfig.packages.base.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "rootDir": ".",
+    "paths": {
+      "@react-native-firebase/app/lib/common/*": ["../app/dist/typescript/commonjs/lib/common/*"],
+      "@react-native-firebase/app/lib/common": ["../app/dist/typescript/commonjs/lib/common"],
+      "@react-native-firebase/app/lib/internal/web/*": [
+        "../app/dist/typescript/commonjs/lib/internal/web/*"
+      ],
+      "@react-native-firebase/app/lib/internal/*": [
+        "../app/dist/typescript/commonjs/lib/internal/*"
+      ],
+      "@react-native-firebase/app/lib/internal": ["../app/dist/typescript/commonjs/lib/internal"],
+      "@react-native-firebase/app": ["../app/dist/typescript/commonjs/lib"]
+    }
+  },
+  "include": ["lib/**/*", "../app/lib/internal/global.d.ts"],
+  "exclude": ["node_modules", "dist", "__tests__", "**/*.test.ts"]
+}

package/lib/ReactNativeFirebaseAppCheckProvider.js

@@ -1,9 +0,0 @@
-export default class ReactNativeFirebaseAppCheckProvider {
-  providerOptions;
-
-  constructor() {}
-
-  configure(options) {
-    this.providerOptions = options;
-  }
-}

package/lib/modular/index.d.ts

@@ -1,149 +0,0 @@
-import { ReactNativeFirebase } from '@react-native-firebase/app';
-import { FirebaseAppCheckTypes } from '..';
-
-import FirebaseApp = ReactNativeFirebase.FirebaseApp;
-import AppCheck = FirebaseAppCheckTypes.Module;
-import AppCheckOptions = FirebaseAppCheckTypes.AppCheckOptions;
-import AppCheckTokenResult = FirebaseAppCheckTypes.AppCheckTokenResult;
-import PartialObserver = FirebaseAppCheckTypes.PartialObserver;
-import Unsubscribe = FirebaseAppCheckTypes.Unsubscribe;
-import AppCheckProvider = FirebaseAppCheckTypes.AppCheckProvider;
-import CustomProviderOptions = FirebaseAppCheckTypes.CustomProviderOptions;
-
-/**
- * Activate App Check for the given app. Can be called only once per app.
- * @param app - FirebaseApp. Optional.
- * @param options - AppCheckOptions
- * @returns {Promise<AppCheck>}
- */
-export function initializeAppCheck(app?: FirebaseApp, options?: AppCheckOptions): Promise<AppCheck>;
-
-/**
- * Get the current App Check token. Attaches to the most recent in-flight request if one is present.
- * Returns null if no token is present and no token requests are in-flight.
- * @param appCheckInstance - AppCheck
- * @param forceRefresh - If true, will always try to fetch a fresh token. If false, will use a cached token if found in storage.
- * @returns {Promise<AppCheckTokenResult>}
- */
-export function getToken(
-  appCheckInstance: AppCheck,
-  forceRefresh?: boolean,
-): Promise<AppCheckTokenResult>;
-
-/**
- * Get a limited-use (consumable) App Check token.
- * For use with server calls to firebase functions or custom backends using the firebase admin SDK
- * @param appCheckInstance - AppCheck
- * @returns {Promise<AppCheckTokenResult>}
- */
-export function getLimitedUseToken(appCheckInstance: AppCheck): 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.
- */
-export function onTokenChanged(
-  appCheckInstance: AppCheck,
-  listener: 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.
- *
- * 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.
- */
-export function onTokenChanged(
-  appCheckInstance: AppCheck,
-  onNext: (tokenResult: AppCheckListenerResult) => void,
-  onError?: (error: Error) => void,
-  onCompletion?: () => void,
-): () => void;
-
-/**
- * Set whether App Check will automatically refresh tokens as needed.
- * @param appCheckInstance - AppCheck
- * @param isAutoRefreshEnabled - boolean
- */
-export function setTokenAutoRefreshEnabled(
-  appCheckInstance: AppCheck,
-  isAutoRefreshEnabled: boolean,
-): void;
-
-/**
- * Custom provider class.
- * @public
- */
-export class CustomProvider implements AppCheckProvider {
-  constructor(customProviderOptions: CustomProviderOptions);
-}
-
-/**
- * React-Native-Firebase AppCheckProvider that allows hot-swapping native AppCheck implementations
- */
-export interface ReactNativeFirebaseAppCheckProviderOptions {
-  /**
-   * debug token to use, if any. Defaults to undefined, pre-configure tokens in firebase web console if needed
-   */
-  debugToken?: string;
-}
-
-export interface ReactNativeFirebaseAppCheckProviderWebOptions extends ReactNativeFirebaseAppCheckProviderOptions {
-  /**
-   * The web provider to use, either `reCaptchaV3` or `reCaptchaEnterprise`, defaults to `reCaptchaV3`
-   */
-  provider?: 'debug' | 'reCaptchaV3' | 'reCaptchaEnterprise';
-
-  /**
-   * siteKey for use in web queries, defaults to `none`
-   */
-  siteKey?: string;
-}
-
-export interface ReactNativeFirebaseAppCheckProviderAppleOptions extends ReactNativeFirebaseAppCheckProviderOptions {
-  /**
-   * The apple provider to use, either `deviceCheck` or `appAttest`, or `appAttestWithDeviceCheckFallback`,
-   * defaults to `DeviceCheck`. `appAttest` requires iOS 14+ or will fail, `appAttestWithDeviceCheckFallback`
-   * will use `appAttest` for iOS14+ and fallback to `deviceCheck` on devices with ios13 and lower
-   */
-  provider?: 'debug' | 'deviceCheck' | 'appAttest' | 'appAttestWithDeviceCheckFallback';
-}
-
-export interface ReactNativeFirebaseAppCheckProviderAndroidOptions extends ReactNativeFirebaseAppCheckProviderOptions {
-  /**
-   * The android provider to use, either `debug` or `playIntegrity`. default is `playIntegrity`.
-   */
-  provider?: 'debug' | 'playIntegrity';
-}
-
-export class ReactNativeFirebaseAppCheckProvider extends AppCheckProvider {
-  /**
-   * 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: {
-    web?: ReactNativeFirebaseAppCheckProviderWebOptions;
-    android?: ReactNativeFirebaseAppCheckProviderAndroidOptions;
-    apple?: ReactNativeFirebaseAppCheckProviderAppleOptions;
-    isTokenAutoRefreshEnabled?: boolean;
-  }): void;
-}

package/lib/modular/index.js

@@ -1,102 +0,0 @@
-/*
- * Copyright (c) 2016-present Invertase Limited & Contributors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this library except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- */
-
-import { getApp } from '@react-native-firebase/app';
-import { MODULAR_DEPRECATION_ARG } from '../../../app/lib/common';
-import ReactNativeFirebaseAppCheckProvider from '../ReactNativeFirebaseAppCheckProvider';
-
-/**
- * @typedef {import('@firebase/app').FirebaseApp} FirebaseApp
- * @typedef {import('..').FirebaseAppCheckTypes.Module} AppCheck
- * @typedef {import('..').FirebaseAppCheckTypes.AppCheckTokenResult} AppCheckTokenResult
- * @typedef {import('..').FirebaseAppCheckTypes.Unsubscribe} Unsubscribe
- * @typedef {import('..').FirebaseAppCheckTypes.PartialObserver} PartialObserver
- * @typedef {import('..').FirebaseAppCheckTypes.AppCheckOptions} AppCheckOptions
- */
-
-/**
- * Activate App Check for the given app. Can be called only once per app.
- * @param {FirebaseApp} [app] - The app to initialize App Check for. Optional.
- * @param {AppCheckOptions} options - App Check options.
- * @returns {Promise<AppCheck>}
- */
-export async function initializeAppCheck(app, options) {
-  if (app) {
-    const appCheck = getApp(app.name).appCheck();
-    await appCheck.initializeAppCheck.call(appCheck, options, MODULAR_DEPRECATION_ARG);
-    return appCheck;
-  }
-  const appCheck = getApp().appCheck();
-  await appCheck.initializeAppCheck.call(appCheck, options, MODULAR_DEPRECATION_ARG);
-  return appCheck;
-}
-
-/**
- * Get the current App Check token. Attaches to the most recent in-flight request if one is present.
- * Returns null if no token is present and no token requests are in-flight.
- * @param {AppCheck} appCheckInstance - The App Check instance.
- * @param {boolean} forceRefresh - Whether to force refresh the token. Optional
- * @returns {Promise<AppCheckTokenResult>}
- */
-export function getToken(appCheckInstance, forceRefresh) {
-  return appCheckInstance.getToken.call(appCheckInstance, forceRefresh, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * Get a limited-use (consumable) App Check token.
- * For use with server calls to firebase functions or custom backends using the firebase admin SDK.
- * @param {AppCheck} appCheckInstance - The App Check instance.
- * @returns {Promise<AppCheckTokenResult>}
- */
-export function getLimitedUseToken(appCheckInstance) {
-  return appCheckInstance.getLimitedUseToken.call(appCheckInstance, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * Set whether App Check will automatically refresh tokens as needed.
- * @param {AppCheck} appCheckInstance - The App Check instance.
- * @param {boolean} isAutoRefreshEnabled - Whether to enable auto-refresh.
- */
-export function setTokenAutoRefreshEnabled(appCheckInstance, isAutoRefreshEnabled) {
-  return appCheckInstance.setTokenAutoRefreshEnabled.call(
-    appCheckInstance,
-    isAutoRefreshEnabled,
-    MODULAR_DEPRECATION_ARG,
-  );
-}
-
-/**
- * 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 {AppCheck} appCheckInstance - The App Check instance.
- * @param {PartialObserver<AppCheckTokenResult>} listener - The listener to register.
- * @returns {Unsubscribe}
- */
-export function onTokenChanged(appCheckInstance, onNextOrObserver, onError, onCompletion) {
-  return appCheckInstance.onTokenChanged.call(
-    appCheckInstance,
-    onNextOrObserver,
-    onError,
-    onCompletion,
-    MODULAR_DEPRECATION_ARG,
-  );
-}
-
-export { ReactNativeFirebaseAppCheckProvider };

package/lib/version.js

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

package/lib/web/RNFBAppCheckModule.android.js

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

package/lib/web/RNFBAppCheckModule.ios.js

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