Algolia <-> Firebase cloud functions

Useful library to keep your Firebase Database of Firebase Cloud Firestore data in sync with Algolia for easy search.

Starting from version 2.0, this library supports Cloud Functions v1.0. If you need to support beta Cloud Functions, use version 1.0.3 instead.

Starting from version 4.0.0, this library supports Node >= 10 and no longer supports Node 8. If you still need to support Node 8, use version 3.3.0 instead.

Starting from version 4.1.2, this library supports only ES6 modules or Typescript.

Starting from version 5.0.0, this library supports Node >= 14 and no longer supports Node 10 and 12. If you still need to support Node 10 or 12, use version 4.1.2 instead.

Starting from version 6.0.0, this library uses Algolia SDK v5 and supports Node version 18 and up.

Starting from version 7.0.0, this library supports can be used only with v2 Cloud Functions and Node version 20 and up.

Installation

In your functions directory:

 npm install --save algolia-firebase-functions

Usage

To use this library in your Functions, first of all you need to set environmental variables for Algolia to initialize connection. Grab your Algolia credentials from the dashboard first and add them to your .env file or enter them during deployment.

You can configure your AlgoliaSearch client like this:

import { defineString } from "firebase-functions/params";
import { searchClient } from "@algolia/client-search";

const algoliaApp = defineString("ALGOLIA_APP_ID");
const algoliaKey = defineString("ALGOLIA_KEY");
const algoliaIndex = defineString("ALGOLIA_INDEX");

const algolia = searchClient(
  algoliaApp.value(),
  algoliaKey.value(),
);

Then you can set up the function for synchronizing Realtime Database like this:

import { onValueWritten } from "firebase-functions/v2/database";
import { initializeApp } from "firebase-admin/app";
import { syncAlgoliaWithFirebase } from "algolia-firebase-functions";

initializeApp();

export const syncAlgoliaFunction = onValueWritten("/myRef/{childRef}", (event) =>
    syncAlgoliaWithFirebase(algolia, algoliaIndex.value(), event.data),
  );

If you're using Firebase Cloud Firestore, you can use the following code:

import { onDocumentWritten } from 'firebase-functions/v2/firestore';
import { syncAlgoliaWithFirestore } from 'algolia-firebase-functions';

export const syncAlgoliaFunction = onDocumentWritten('/myDocument/{childDocument}',
   (event) => syncAlgoliaWithFirestore(algolia, index, event.data);
);

And redeploy your functions:

firebase deploy --only functions

Now, after any changes made with your references, it will be sent to Algolia, so you'll be sure that users can search on the newest data.