@now-ims/fastify-firebase

Fastify Firebase Admin plugin

Showing:

Popularity

Downloads/wk

104

GitHub Stars

9

Maintenance

Last Commit

7mos ago

Contributors

0

Package

Dependencies

2

Size (min+gzip)

195.5KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

fastify-firebase

Known Vulnerabilities Coverage Status js-standard-style npm (scoped)

This plugin adds the Firebase Admin SDK to Fastify so you can easy use Firebase Auth, Firestore, Cloud Storage, Cloud Messaging, and more.

Install

yarn add @now-ims/fastify-firebase
npm i @now-ims/fastify-firebase -S

Usage

Add it to you project with register and you're done!
This plugin will add a firebase namespace in your Fastify instance - uou can access the Firebase SDK objects via fastify.firebase:

auth - e.g., fastify.firebase.auth().createUser()
firestore - e.g., fastify.firebase.firestore().collection('users').get()
storage - e.g., fastify.firebase.store().bucket('thumbnails')
machineLearning - e.g., fastify.firebase.machineLearning().createModel()

API

  • options - if deploying from Google Cloud options are optional
    • name (Default: 'default', Type: string) is required if you want to load configurations for multiple projects
    • cert (Optional, Type: string) is required if you you are not on Google Cloud or want to load multiple configurations
    • databaseURL (Optional, Type: string) is required for Realtime Database
    • storageBucket (Optional, Type: string) e.g., <BUCKET_NAME>.appspot.com - do not include any gs://
    • projectId (Default: 'cert.projectId', Type: string) e.g., my-google-cloud-project

Example

Google Cloud - Application Default Credentials

const fastify = require('fastify')({ logger: true });

fastify.register(require('fastify-sensible'));
fastify.register(require('@now-ims/fastify-firebase'));

fastify.get('/user/:id', async (req, reply) => {
  const user = await fastify.firebase
    .firestore()
    .collection('users')
    .doc(req.params.id)
    .get();

  if (!user.exists) {
    return reply.notFound();
  }

  return user.data();
});

fastify.listen(4331, (err) => {
  if (err) throw err;
  console.log(`server listening on ${fastify.server.address().port}`);
});

Register multiple Firebase projects w/ options and Separate Route File

const fastify = require('fastify')({ logger: true });

fastify.register(require('fastify-sensible'));

// Here we will load multiple configurations for multiple projects!
// You most likely will not need this, but it is available should you need it.
fastify.register(require('@now-ims/fastify-firebase'), {
  name: 'client1',
  cert: '/path/to/my/cert/',
});
// this can be called with either fastify.firebase or fastify.firebase['client1']

fastify.register(require('@now-ims/fastify-firebase'), {
  name: 'client2',
  cert: process.env.FIREBASE_CONFIG,
  storageBucket: 'thumbnails.appspot.com',
});
// this can only be called with fastify.firebase['client2']

fastify.listen(4331, (err) => {
  if (err) throw err;
  console.log(`server listening on ${fastify.server.address().port}`);
});

In your route file you can simply do the following e.g.:

async function userRoute(fastify, options) {
  fastify.get('/users/:id', async (req, reply) => {
    const { id } = req.params;
    const user = await fastify.firebase['client2']
      .firestore()
      .collection('users')
      .get(id)
      .get();

    if (!user.exists) {
      return reply.notFound();
    }

    return user.data();
  });
}

Acknowledgements

This project is sponsored and maintained by:

License

Licensed under MIT.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100