@firebase/app-check-compat

What is @firebase/app-check-compat?

The @firebase/app-check-compat package is designed to work with Firebase App Check in a way that is compatible with the older Firebase JavaScript SDKs. It helps in protecting your Firebase resources from abuse, such as billing fraud or phishing, by ensuring that only your apps can access your Firebase services.

What are @firebase/app-check-compat's main functionalities?

Initialize App Check with reCAPTCHA

This code initializes Firebase App Check using a reCAPTCHA provider. It helps in ensuring that the client interacting with your Firebase services is a legitimate instance of your app, by solving a CAPTCHA challenge.

import firebase from 'firebase/app';
import 'firebase/app-check';

// Initialize Firebase app
firebase.initializeApp({
  apiKey: 'your-api-key',
  authDomain: 'your-auth-domain',
  // other config
});

// Initialize App Check with reCAPTCHA provider
const appCheck = firebase.appCheck();
appCheck.activate('your-recaptcha-public-key', true);

Integrate with Firebase services

This code demonstrates how Firebase services like Authentication and Firestore can be used normally after integrating App Check. App Check works in the background to secure these requests.

import firebase from 'firebase/app';
import 'firebase/auth';
import 'firebase/firestore';

// Assuming App Check and Firebase app have been initialized

// Use Firebase services as usual
firebase.auth().onAuthStateChanged(user => {
  console.log(user);
});

firebase.firestore().collection('users').get().then(snapshot => {
  snapshot.forEach(doc => console.log(doc.data()));
});

Other packages similar to @firebase/app-check-compat

@firebase/app-check

This is the standard version of Firebase App Check designed for use with the modern Firebase JavaScript SDK (v9+). It offers similar functionalities but with a modular approach, promoting better tree-shaking and potentially smaller bundle sizes compared to @firebase/app-check-compat.

recaptcha-v3

While not a direct alternative, recaptcha-v3 is a package that provides Google reCAPTCHA v3 services which can be used for similar purposes of protecting web apps from abuse. However, it does not integrate directly with Firebase services.

README

@firebase/app-check-compat

This is the Firebase App Check component (compat version) of the Firebase JS SDK.

This package is not intended for direct usage, and should only be used via the officially supported firebase package.