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

@bg-dev/nuxt-fcm

v0.2.13

Published

A Nuxt 3 module for integrating Firebase Cloud messaging

Downloads

493

Readme

Nuxt FCM

npm version npm downloads License Nuxt

A Nuxt 3 module for integrating Firebase Cloud messaging. This module is based on Firebase JS SDK on the client side and Firebase Admin SDK on the server side.

Features

  • ✔️ Listen to messages via useFcm composable
  • ✔️ Send, subscribe & unsubscribe from topics via useFcmTopic composable

Quick Setup

  1. Add dependencies to your project
# Using npm
npm install --save-dev @bg-dev/nuxt-fcm

# Using yarn
yarn add --dev @bg-dev/nuxt-fcm
  1. Add @bg-dev/nuxt-fcm to the modules section of nuxt.config.ts
export default defineNuxtConfig({
  modules: ["@bg-dev/nuxt-fcm"],
});
  1. Set fcm config object
  • firebaseConfig Firebase project configuration.
  • vapidKey Public server key provided to push services docs.
  • serviceAccount Firebase admin credentials docs. You can ignore this property in case the app server is not needed.
  1. If you are using an app server, make sure to enable Cloud messaging API docs.

That's it! You can now use Nuxt FCM in your Nuxt app ✨

Usage

Authorization

By default all the topic's related features are inaccessible. Add a server-side middleware to check the user's role and set the permissions accordingly.

// server/middleware/fcm.ts

import { setPermissions } from "#fcm";

export default defineEventHandler((event) => {
  setPermissions(event, {
    topic: {
      send: true,
      subscribe: true,
      unsubscribe: true,
    },
  });
});

Listen to messages

In the foreground, when a message is received it's passed to the page and the onMessage event is dispatched with the payload.

const { onMessage } = useFcm();

onMessage(console.log);

In the background, notifications are automatically shown when a message is received. To add custom logic, the service worker can be extended via the serviceWorkerScript config option (source).

  // nuxt.config.ts
  fcm: {
    serviceWorkerScript: `
      messaging.onBackgroundMessage((payload) => {
        console.log("Received background message ", payload);
      })

      function onNotificationClick(event) {
        console.log('[firebase-messaging-sw.js] Notification clicked', event)
        event.notification.close();
      }
    `,
  },

Add other Firebase services

You can integrate other Firebase services such as Google Analytics to provide insights into user behavior and engagement stats.

// nuxt.config.ts
// Exclude package from vite optimization

  vite: {
    optimizeDeps: {
      exclude: ["firebase/analytics"],
    },
  },
// plugins/analytics.client.ts
// Define a client-side plugin to expose the service's instance

import { getAnalytics } from "firebase/analytics";

export default defineNuxtPlugin(() => {
  const analytics = getAnalytics();

  return {
    provide: {
      analytics,
    },
  };
});

Appendix

Development

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release