@react-native-firebase/app-check 21.7.0 → 21.7.2

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [21.7.2](https://github.com/invertase/react-native-firebase/compare/v21.7.1...v21.7.2) (2025-02-05)
+
+**Note:** Version bump only for package @react-native-firebase/app-check
+
+## [21.7.1](https://github.com/invertase/react-native-firebase/compare/v21.7.0...v21.7.1) (2025-01-20)
+
+**Note:** Version bump only for package @react-native-firebase/app-check
+
 ## [21.7.0](https://github.com/invertase/react-native-firebase/compare/v21.6.2...v21.7.0) (2025-01-16)
 
 **Note:** Version bump only for package @react-native-firebase/app-check

package/README.md

@@ -50,7 +50,7 @@ yarn add @react-native-firebase/app-check
 ---
 
 <p>
-  <img align="left" width="75px" src="https://static.invertase.io/assets/invertase-logo-small.png">
+  <img align="left" width="75px" src="https://static.invertase.io/assets/invertase/invertase-rounded.png">
   <p align="left">
     Built and maintained with 💛 by <a href="https://invertase.io">Invertase</a>.
   </p>

package/__tests__/appcheck.test.ts

@@ -1,12 +1,20 @@
-import { describe, expect, it } from '@jest/globals';
+import { jest, beforeEach, describe, expect, it } from '@jest/globals';
+// @ts-ignore test
+import FirebaseModule from '../../app/lib/internal/FirebaseModule';
+
+import {
+  createCheckV9Deprecation,
+  CheckV9DeprecationFunction,
+} from '../../app/lib/common/unitTestUtils';
 
 import {
   firebase,
   initializeAppCheck,
   getToken,
   getLimitedUseToken,
-  addTokenListener,
   setTokenAutoRefreshEnabled,
+  onTokenChanged,
+  CustomProvider,
 } from '../lib';
 
 describe('appCheck()', function () {
@@ -47,12 +55,117 @@ describe('appCheck()', function () {
       expect(getLimitedUseToken).toBeDefined();
     });
 
-    it('`addTokenListener` function is properly exposed to end user', function () {
-      expect(addTokenListener).toBeDefined();
-    });
-
     it('`setTokenAutoRefreshEnabled` function is properly exposed to end user', function () {
       expect(setTokenAutoRefreshEnabled).toBeDefined();
     });
+
+    it('`CustomProvider` function is properly exposed to end user', function () {
+      expect(CustomProvider).toBeDefined();
+    });
+  });
+
+  describe('test `console.warn` is called for RNFB v8 API & not called for v9 API', function () {
+    let appCheckRefV9Deprecation: CheckV9DeprecationFunction;
+    let staticsRefV9Deprecation: CheckV9DeprecationFunction;
+
+    beforeEach(function () {
+      appCheckRefV9Deprecation = createCheckV9Deprecation(['appCheck']);
+      staticsRefV9Deprecation = createCheckV9Deprecation(['appCheck', 'statics']);
+
+      // @ts-ignore test
+      jest.spyOn(FirebaseModule.prototype, 'native', 'get').mockImplementation(() => {
+        return new Proxy(
+          {},
+          {
+            get: () =>
+              jest.fn().mockResolvedValue({
+                source: 'cache',
+                changes: [],
+                documents: [],
+                metadata: {},
+                path: 'foo',
+              } as never),
+          },
+        );
+      });
+    });
+
+    describe('AppCheck', function () {
+      it('appCheck.activate()', function () {
+        const app = firebase.app();
+        const appCheck = firebase.appCheck();
+        appCheckRefV9Deprecation(
+          () =>
+            initializeAppCheck(app, {
+              provider: {
+                providerOptions: {
+                  android: {
+                    provider: 'playIntegrity',
+                  },
+                },
+              },
+              isTokenAutoRefreshEnabled: true,
+            }),
+          () => appCheck.activate('string'),
+          'activate',
+        );
+      });
+
+      it('appCheck.setTokenAutoRefreshEnabled()', function () {
+        const appCheck = firebase.appCheck();
+        appCheckRefV9Deprecation(
+          () => setTokenAutoRefreshEnabled(appCheck, true),
+          () => appCheck.setTokenAutoRefreshEnabled(true),
+          'setTokenAutoRefreshEnabled',
+        );
+      });
+
+      it('appCheck.getToken()', function () {
+        const appCheck = firebase.appCheck();
+        appCheckRefV9Deprecation(
+          () => getToken(appCheck, true),
+          () => appCheck.getToken(true),
+          'getToken',
+        );
+      });
+
+      it('appCheck.getLimitedUseToken()', function () {
+        const appCheck = firebase.appCheck();
+        appCheckRefV9Deprecation(
+          () => getLimitedUseToken(appCheck),
+          () => appCheck.getLimitedUseToken(),
+          'getLimitedUseToken',
+        );
+      });
+
+      it('appCheck.onTokenChanged()', function () {
+        const appCheck = firebase.appCheck();
+        appCheckRefV9Deprecation(
+          () =>
+            onTokenChanged(
+              appCheck,
+              () => {},
+              () => {},
+              () => {},
+            ),
+          () =>
+            appCheck.onTokenChanged(
+              () => {},
+              () => {},
+              () => {},
+            ),
+          'onTokenChanged',
+        );
+      });
+
+      it('CustomProvider', function () {
+        const appCheck = firebase.appCheck;
+        staticsRefV9Deprecation(
+          () => CustomProvider,
+          () => appCheck.CustomProvider,
+          'CustomProvider',
+        );
+      });
+    });
   });
 });

package/lib/index.d.ts

@@ -196,7 +196,6 @@ export namespace FirebaseAppCheckTypes {
    */
   export type AppCheckListenerResult = AppCheckToken & { readonly appName: string };
 
-  // eslint-disable-next-line @typescript-eslint/no-empty-interface
   export interface Statics {
     // firebase.appCheck.* static props go here
     CustomProvider: typeof CustomProvider;

package/lib/modular/index.d.ts

@@ -1,11 +1,14 @@
-import { FirebaseApp } from '@firebase/app-types';
+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.
@@ -39,19 +42,42 @@ export function getToken(
 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.
- * @param appCheckInstance - AppCheck
- * @param listener - PartialObserver<AppCheckTokenResult>
- * @returns {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.
+ *
+ * @returns A function that unsubscribes this listener.
  */
-export function addTokenListener(
+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
@@ -61,3 +87,11 @@ export function setTokenAutoRefreshEnabled(
   appCheckInstance: AppCheck,
   isAutoRefreshEnabled: boolean,
 ): void;
+
+/**
+ * Custom provider class.
+ * @public
+ */
+export class CustomProvider implements AppCheckProvider {
+  constructor(customProviderOptions: CustomProviderOptions);
+}

package/lib/modular/index.js

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
 /*
  * Copyright (c) 2016-present Invertase Limited & Contributors
  *
@@ -17,6 +16,8 @@
  */
 
 import { firebase } from '..';
+import { MODULAR_DEPRECATION_ARG } from '../../../app/lib/common';
+import CustomProvider from '../ReactNativeFirebaseAppCheckProvider';
 
 /**
  * @typedef {import('@firebase/app').FirebaseApp} FirebaseApp
@@ -35,11 +36,12 @@ import { firebase } from '..';
  */
 export async function initializeAppCheck(app, options) {
   if (app) {
-    await firebase.app(app.name).appCheck().initializeAppCheck(options);
+    const appCheck = firebase.app(app.name).appCheck();
+    await appCheck.initializeAppCheck.call(appCheck, options, MODULAR_DEPRECATION_ARG);
     return { app: firebase.app(app.name) };
   }
-
-  await firebase.app().appCheck().initializeAppCheck(options);
+  const appCheck = firebase.app().appCheck();
+  await appCheck.initializeAppCheck.call(appCheck, options, MODULAR_DEPRECATION_ARG);
   return { app: firebase.app() };
 }
 
@@ -51,7 +53,8 @@ export async function initializeAppCheck(app, options) {
  * @returns {Promise<AppCheckTokenResult>}
  */
 export function getToken(appCheckInstance, forceRefresh) {
-  return appCheckInstance.app.appCheck().getToken(forceRefresh);
+  const appCheck = appCheckInstance.app.appCheck();
+  return appCheck.getToken.call(appCheck, forceRefresh, MODULAR_DEPRECATION_ARG);
 }
 
 /**
@@ -61,29 +64,43 @@ export function getToken(appCheckInstance, forceRefresh) {
  * @returns {Promise<AppCheckTokenResult>}
  */
 export function getLimitedUseToken(appCheckInstance) {
-  return appCheckInstance.app.appCheck().getLimitedUseToken();
+  const appCheck = appCheckInstance.app.appCheck();
+  return appCheck.getLimitedUseToken.call(appCheck, 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.
+ * Set whether App Check will automatically refresh tokens as needed.
  * @param {AppCheck} appCheckInstance - The App Check instance.
- * @param {PartialObserver<AppCheckTokenResult>} listener - The listener to register.
- * @returns {Unsubscribe}
+ * @param {boolean} isAutoRefreshEnabled - Whether to enable auto-refresh.
  */
-export function addTokenListener(appCheckInstance, listener) {
-  // Not implemented on React Native
-  // See packages/app-check/lib/index.js:127
-  throw new Error('addTokenListener is not implemented on React Native');
+export function setTokenAutoRefreshEnabled(appCheckInstance, isAutoRefreshEnabled) {
+  const appCheck = appCheckInstance.app.appCheck();
+  return appCheck.setTokenAutoRefreshEnabled.call(
+    appCheck,
+    isAutoRefreshEnabled,
+    MODULAR_DEPRECATION_ARG,
+  );
 }
 
 /**
- * Set whether App Check will automatically refresh tokens as needed.
+ * 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 {boolean} isAutoRefreshEnabled - Whether to enable auto-refresh.
+ * @param {PartialObserver<AppCheckTokenResult>} listener - The listener to register.
+ * @returns {Unsubscribe}
  */
-export function setTokenAutoRefreshEnabled(appCheckInstance, isAutoRefreshEnabled) {
-  return appCheckInstance.app.appCheck().setTokenAutoRefreshEnabled(isAutoRefreshEnabled);
+export function onTokenChanged(appCheckInstance, onNextOrObserver, onError, onCompletion) {
+  const appCheck = appCheckInstance.app.appCheck();
+  return appCheck.onTokenChanged.call(
+    appCheck,
+    onNextOrObserver,
+    onError,
+    onCompletion,
+    MODULAR_DEPRECATION_ARG,
+  );
 }
+
+export { CustomProvider };

package/lib/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/app-check",
-  "version": "21.7.0",
+  "version": "21.7.2",
   "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": "21.7.0",
+    "@react-native-firebase/app": "21.7.2",
     "expo": ">=47.0.0"
   },
   "devDependencies": {
-    "expo": "^50.0.21"
+    "expo": "^52.0.30"
   },
   "peerDependenciesMeta": {
     "expo": {
@@ -39,5 +39,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c027ef2d772882c091383b7ff81b65573f549b5d"
+  "gitHead": "209b36e4b469355e4d024ecdeb6c875f8bd8a187"
 }

package/plugin/build/ios/appDelegate.js

@@ -41,7 +41,7 @@ function modifyObjcAppDelegate(contents) {
             comment: '//',
         }).contents;
     }
-    catch (e) {
+    catch (_) {
         // tests if the opening `{` is in the new line
         const multilineMatcher = new RegExp(fallbackInvocationLineMatcher.source + '.+\\n*{');
         const isHeaderMultiline = multilineMatcher.test(contents);

package/plugin/src/ios/appDelegate.ts

@@ -49,7 +49,7 @@ export function modifyObjcAppDelegate(contents: string): string {
       offset: 0, // new line will be inserted right above matched anchor
       comment: '//',
     }).contents;
-  } catch (e: any) {
+  } catch (_: any) {
     // tests if the opening `{` is in the new line
     const multilineMatcher = new RegExp(fallbackInvocationLineMatcher.source + '.+\\n*{');
     const isHeaderMultiline = multilineMatcher.test(contents);

package/plugin/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["./src/index.ts","./src/ios/appDelegate.ts","./src/ios/index.ts"],"version":"5.6.2"}
+{"root":["./src/index.ts","./src/ios/appDelegate.ts","./src/ios/index.ts"],"version":"5.7.3"}