@react-native-firebase/app-check 20.3.0 → 20.4.0

package/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [20.4.0](https://github.com/invertase/react-native-firebase/compare/v20.3.0...v20.4.0) (2024-08-13)
+
+**Note:** Version bump only for package @react-native-firebase/app-check
+
 ## [20.3.0](https://github.com/invertase/react-native-firebase/compare/v20.2.1...v20.3.0) (2024-07-19)
 
 **Note:** Version bump only for package @react-native-firebase/app-check

package/__tests__/appcheck.test.ts

@@ -1,6 +1,13 @@
 import { describe, expect, it } from '@jest/globals';
 
-import { firebase } from '../lib';
+import {
+  firebase,
+  initializeAppCheck,
+  getToken,
+  getLimitedUseToken,
+  addTokenListener,
+  setTokenAutoRefreshEnabled,
+} from '../lib';
 
 describe('appCheck()', function () {
   describe('namespace', function () {
@@ -26,4 +33,26 @@ describe('appCheck()', function () {
       expect(firebase.appCheck().newReactNativeFirebaseAppCheckProvider()).toBeDefined();
     });
   });
+
+  describe('modular', function () {
+    it('`initializeAppCheck` function is properly exposed to end user', function () {
+      expect(initializeAppCheck).toBeDefined();
+    });
+
+    it('`getToken` function is properly exposed to end user', function () {
+      expect(getToken).toBeDefined();
+    });
+
+    it('`getLimitedUseToken` function is properly exposed to end user', 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();
+    });
+  });
 });

package/lib/index.d.ts

@@ -341,6 +341,8 @@ export const firebase: ReactNativeFirebase.Module & {
 
 export default defaultExport;
 
+export * from './modular';
+
 /**
  * Attach namespace to `firebase.` and `FirebaseApp.`.
  */

package/lib/index.js

@@ -36,14 +36,6 @@ import fallBackModule from './web/RNFBAppCheckModule';
 
 import version from './version';
 
-export {
-  addTokenListener,
-  getToken,
-  getLimitedUseToken,
-  initializeAppCheck,
-  setTokenAutoRefreshEnabled,
-} from './modular/index';
-
 const namespace = 'appCheck';
 
 const nativeModuleName = 'RNFBAppCheckModule';
@@ -240,6 +232,8 @@ export default createModuleNamespace({
   ModuleClass: FirebaseAppCheckModule,
 });
 
+export * from './modular';
+
 // import appCheck, { firebase } from '@react-native-firebase/app-check';
 // appCheck().X(...);
 // firebase.appCheck().X(...);

package/lib/modular/index.d.ts

@@ -0,0 +1,63 @@
+import { FirebaseApp } from '@firebase/app-types';
+import { FirebaseAppCheckTypes } from '..';
+
+import AppCheck = FirebaseAppCheckTypes.Module;
+import AppCheckOptions = FirebaseAppCheckTypes.AppCheckOptions;
+import AppCheckTokenResult = FirebaseAppCheckTypes.AppCheckTokenResult;
+import PartialObserver = FirebaseAppCheckTypes.PartialObserver;
+import Unsubscribe = FirebaseAppCheckTypes.Unsubscribe;
+
+/**
+ * Activate App Check for the given app. Can be called only once per app.
+ * @param app - FirebaseApp. Optional.
+ * @param options - AppCheckOptions
+ * @returns {Promise<{ app: FirebaseApp }>}
+ */
+export function initializeAppCheck(
+  app?: FirebaseApp,
+  options?: AppCheckOptions,
+): Promise<{ app: FirebaseApp }>;
+
+/**
+ * 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 - boolean
+ * @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.
+ * @param appCheckInstance - AppCheck
+ * @param listener - PartialObserver<AppCheckTokenResult>
+ * @returns {Unsubscribe}
+ */
+export function addTokenListener(
+  appCheckInstance: AppCheck,
+  listener: PartialObserver<AppCheckTokenResult>,
+): Unsubscribe;
+
+/**
+ * Set whether App Check will automatically refresh tokens as needed.
+ * @param appCheckInstance - AppCheck
+ * @param isAutoRefreshEnabled - boolean
+ */
+export function setTokenAutoRefreshEnabled(
+  appCheckInstance: AppCheck,
+  isAutoRefreshEnabled: boolean,
+): void;

package/lib/modular/index.js

@@ -18,11 +18,20 @@
 
 import { firebase } from '..';
 
+/**
+ * @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 app - FirebaseApp. Optional.
- * @param options - AppCheckOptions
- * @returns {AppCheck}
+ * @param {FirebaseApp} [app] - The app to initialize App Check for. Optional.
+ * @param {AppCheckOptions} options - App Check options.
+ * @returns {Promise<{ app: FirebaseApp }>}
  */
 export async function initializeAppCheck(app, options) {
   if (app) {
@@ -37,8 +46,8 @@ export async function initializeAppCheck(app, options) {
 /**
  * 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 - boolean
+ * @param {AppCheck} appCheckInstance - The App Check instance.
+ * @param {boolean} forceRefresh - Whether to force refresh the token.
  * @returns {Promise<AppCheckTokenResult>}
  */
 export function getToken(appCheckInstance, forceRefresh) {
@@ -47,8 +56,8 @@ export function getToken(appCheckInstance, forceRefresh) {
 
 /**
  * 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
+ * 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) {
@@ -60,8 +69,8 @@ export function getLimitedUseToken(appCheckInstance) {
  * 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>
+ * @param {AppCheck} appCheckInstance - The App Check instance.
+ * @param {PartialObserver<AppCheckTokenResult>} listener - The listener to register.
  * @returns {Unsubscribe}
  */
 export function addTokenListener(appCheckInstance, listener) {
@@ -72,8 +81,8 @@ export function addTokenListener(appCheckInstance, listener) {
 
 /**
  * Set whether App Check will automatically refresh tokens as needed.
- * @param appCheckInstance - AppCheck
- * @param isAutoRefreshEnabled - boolean
+ * @param {AppCheck} appCheckInstance - The App Check instance.
+ * @param {boolean} isAutoRefreshEnabled - Whether to enable auto-refresh.
  */
 export function setTokenAutoRefreshEnabled(appCheckInstance, isAutoRefreshEnabled) {
   return appCheckInstance.app.appCheck().setTokenAutoRefreshEnabled(isAutoRefreshEnabled);

package/lib/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/app-check",
-  "version": "20.3.0",
+  "version": "20.4.0",
   "author": "Invertase <oss@invertase.io> (http://invertase.io)",
   "description": "React Native Firebase - App Check",
   "main": "lib/index.js",
@@ -25,7 +25,7 @@
     "appCheck"
   ],
   "peerDependencies": {
-    "@react-native-firebase/app": "20.3.0",
+    "@react-native-firebase/app": "20.4.0",
     "expo": ">=47.0.0"
   },
   "devDependencies": {
@@ -39,5 +39,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "a916b37b022cf40588fa0fd915b7ab901e2458d0"
+  "gitHead": "3ac3e9623674a8db52c111b4aa0a85a883260116"
 }