@react-native-firebase/app-check 17.2.0 → 17.3.0

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [17.3.0](https://github.com/invertase/react-native-firebase/compare/v17.2.0...v17.3.0) (2023-02-15)
+
+### Features
+
+- **app-check:** Expose modular API that matches the Firebase web JS SDK v9 API ([#6912](https://github.com/invertase/react-native-firebase/issues/6912)) ([bf02676](https://github.com/invertase/react-native-firebase/commit/bf0267609251a5b8e4245c300678fe7d7ea53d92))
+
+### Bug Fixes
+
+- **app-check, types:** Correct ReactNativeFirebaseAppCheckProvider options type ([#6911](https://github.com/invertase/react-native-firebase/issues/6911)) ([5d7241b](https://github.com/invertase/react-native-firebase/commit/5d7241b124dc283852efb4c549f6888005101ecd))
+
 ## [17.2.0](https://github.com/invertase/react-native-firebase/compare/v17.1.0...v17.2.0) (2023-02-15)
 
 ### Features

package/lib/index.d.ts

@@ -135,12 +135,12 @@ export namespace FirebaseAppCheckTypes {
      * 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(
-      web?: ReactNativeFirebaseAppCheckProviderWebOptions,
-      android?: ReactNativeFirebaseAppCheckProviderAndroidOptions,
-      apple?: ReactNativeFirebaseAppCheckProviderAppleOptions,
-      isTokenAutoRefreshEnabled?: boolean,
-    ): Promise<void>;
+    configure(options: {
+      web?: ReactNativeFirebaseAppCheckProviderWebOptions;
+      android?: ReactNativeFirebaseAppCheckProviderAndroidOptions;
+      apple?: ReactNativeFirebaseAppCheckProviderAppleOptions;
+      isTokenAutoRefreshEnabled?: boolean;
+    }): Promise<void>;
   }
 
   /**

package/lib/index.js

@@ -26,6 +26,13 @@ import ReactNativeFirebaseAppCheckProvider from './ReactNativeFirebaseAppCheckPr
 
 import version from './version';
 
+export {
+  addTokenListener,
+  getToken,
+  initializeAppCheck,
+  setTokenAutoRefreshEnabled,
+} from './modular/index';
+
 const statics = {};
 
 const namespace = 'appCheck';

package/lib/modular/index.js

@@ -0,0 +1,70 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/*
+ * 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 { firebase } from '..';
+
+/**
+ * Activate App Check for the given app. Can be called only once per app.
+ * @param app - FirebaseApp. Optional.
+ * @param options - AppCheckOptions
+ * @returns {AppCheck}
+ */
+export async function initializeAppCheck(app, options) {
+  if (app) {
+    await firebase.app(app.name).appCheck().initializeAppCheck(options);
+    return { app: firebase.app(app.name) };
+  }
+
+  await firebase.app().appCheck().initializeAppCheck(options);
+  return { app: firebase.app() };
+}
+
+/**
+ * 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, forceRefresh) {
+  return appCheckInstance.app.appCheck().getToken(forceRefresh);
+}
+
+/**
+ * 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, listener) {
+  // Not implemented on React Native
+  // See packages/app-check/lib/index.js:127
+  throw new Error('addTokenListener is not implemented on React Native');
+}
+
+/**
+ * Set whether App Check will automatically refresh tokens as needed.
+ * @param appCheckInstance - AppCheck
+ * @param isAutoRefreshEnabled - boolean
+ */
+export function setTokenAutoRefreshEnabled(appCheckInstance, isAutoRefreshEnabled) {
+  return appCheckInstance.app.appCheck().setTokenAutoRefreshEnabled(isAutoRefreshEnabled);
+}

package/lib/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/app-check",
-  "version": "17.2.0",
+  "version": "17.3.0",
   "author": "Invertase <oss@invertase.io> (http://invertase.io)",
   "description": "React Native Firebase - App Check",
   "main": "lib/index.js",
@@ -23,10 +23,10 @@
     "appCheck"
   ],
   "peerDependencies": {
-    "@react-native-firebase/app": "17.2.0"
+    "@react-native-firebase/app": "17.3.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "57666670bd7fa4121a6598c639c4b2a24b9d181c"
+  "gitHead": "2e51817c937247ffe51fb6234c164744c2a71693"
 }