npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@fiboup/hono-firebase-auth

v1.0.5

Published

Firebase Authentication for Hono

Downloads

47

Readme

Firebase Authentication/Identity Platform integration for Hono

This package allows easily integrate Firebase Authentication/Identity Platform to your Hono API project.

Features

  • Hono middleware to decode and verify JWT token issued by Firebase Authentication service
  • Hono context variable currentUser for you to access any where in your application
  • Allowed to custom currentUser shape

Install

With NPM

npm install @fiboup/hono-firebase-auth

With Yarn

yarn add @fiboup/hono-firebase-auth

With pnpm

pnpm add @fiboup/hono-firebase-auth

Usage

Add authentication middleware to your Hono app

import { Hono } from "hono";
import { validateFirebaseAuth } from "@fiboup/hono-firebase-auth";

const app = new Hono();
app.use(
  "*",
  validateFirebaseAuth({
    projectId: "<your_firebase_project_id>",
  })
);

Note: Go to your Firebase project, then visit Project settings for the project id

Configure to catch Firebase JWT token decoding error for Hono

import { Hono } from "hono";
import { JwtDecodeError } from "@fiboup/hono-firebase-auth";

const app = new Hono();

app.onError((err, c) => {
  if (err instanceof JwtDecodeError) {
    return new Response(err.message, {
      status: 401,
    });
  }
  console.log(err);
  return new Response("Uncaught exception", {
    status: 500,
  });
});

Get current user details which is decoded from Firebase JWT token

You can get the current user from Hono context with the key currentUser

import { Hono } from "hono";
import { validateFirebaseAuth } from "@fiboup/hono-firebase-auth";

const app = new Hono();
app.use(
  "*",
  validateFirebaseAuth({
    projectId: "<your_firebase_project_id>",
  })
);

app.get('/me', (c) => {
  const currentUser = c.get('currentUser')
  return c.json(currentUser)
})

To make it type-safe, you can use DefaultFirebaseAuthInjectedVariables

import type { DefaultFirebaseAuthInjectedVariables } from "@fiboup/hono-firebase-auth";

type Variables = DefaultFirebaseAuthInjectedVariables

const app = new Hono<{ Variables: Variables }>()

If you want to custom the context variable key, you can specify in the middleware config

import { Hono } from "hono";
import { validateFirebaseAuth } from "@fiboup/hono-firebase-auth";

const app = new Hono();
app.use(
  "*",
  validateFirebaseAuth({
    projectId: "<your_firebase_project_id>",
    currentUserContextKey: 'custom_current_user'
  })
);

Leave the currentUserContextKey a blank string to disable current user context

Custom current user context info with transformCurrentUser callback

import { Hono } from "hono";
import { validateFirebaseAuth } from "@fiboup/hono-firebase-auth";
import type { DecodedIdToken } from "@fiboup/firebase-auth";

type MyCustomCurrentUser = {
    userId: string
}

const app = new Hono();
app.use(
  "*",
  validateFirebaseAuth({
    transformCurrentUser: <MyCustomCurrentUser>(decodedToken: DecodedIdToken) => {
        return {
            userId: decodedToken.sub,
        }
    }
  })
);

To make your custom current user context type-safe, don't forget to write your custom Hono variable

type Variables = {
    currentUser?: MyCustomCurrentUser
}

const app = new Hono<{ Variables: Variables }>()

License

MIT © Fiboup