You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

met-generate-int

Package Overview
Dependencies
Maintainers
1
Versions
169
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

met-generate-int

return a random int between two int numbers


Version published
Weekly downloads
21
decreased by-19.23%
Maintainers
1
Created
Weekly downloads
 

Readme

Source

Arad Push Notification system (APN)

You can use this sdk in node.js applications such as ReactJS, VueJS or AngularJS.

Before start (IMPORTANT)

You need The firebase configuration object and vapidKey before initialize APN sdk.

— Firebase Configuration

  1. Create a Firebase project: Open the Firebase console and click on “Add project”. Follow the instructions to create your project.
  2. Get your Firebase configuration: After your project is created, click on the gear icon next to “Project Overview” and select “Project settings”. Here, you’ll find your Firebase SDK snippet under the “General” tab. It will look something like this:
const firebaseConfig = {
 apiKey: "AIzaSy...",
 authDomain: "your-project-id.firebaseapp.com",
 databaseURL: "https://your-project-id.firebaseio.com",
 projectId: "your-project-id",
 storageBucket: "your-project-id.appspot.com",
 messagingSenderId: "sender-id",
 appId: "app-id",
 measurementId: "G-measurement-id",
};

— VAPID Key

  1. Enable Cloud Messaging in your Firebase project: In the Firebase console, navigate to “Cloud Messaging” under the “Grow” section. Here, you can enable Firebase Cloud Messaging for your project.
  2. Get your VAPID key: After enabling Cloud Messaging, you’ll find your VAPID key under the “Cloud Messaging” settings. It will be labeled as “Web Push certificates”. It will look something like this:
const vapidkey = 'BB0rUaCvQVl1NA9sENxz9y...'

Installation

Always get the latest version with the following command:

npm install met-generate-int

Import

import APN from ‘met-generate-int’

How to use

After getting the firebaseConfig and vapidKey try to create an object of APN in your App.js (react) or App.vue (vuejs) and start coding:


  const firebaseConfig = {
    apiKey: "AIzaSy...",
    authDomain: "your-project-id.firebaseapp.com",
    databaseURL: "https://your-project-id.firebaseio.com",
    projectId: "your-project-id",
    storageBucket: "your-project-id.appspot.com",
    messagingSenderId: "sender-id",
    appId: "app-id",
    measurementId: "G-measurement-id",
  };
  const vapidkey = 'BB0rUaCvQVl1NA9sENxz9y...';

  // create apn object from APN
  const apn = new APN();

  //  initialize apn ↓
  apn.init(firebaseConfig, vapidKey).then(() => {
    console.log('Initialize successful');
    apn.setKey('arad-secret-key');
    if (!apn.checkConfig()) {
      apn.setConfig('clientUserName', 'clientPassword', 'connectionURL');
    }
  }).catch((error) => {
    console.error('Error: ', error);
    // here you can handle retry to call apn.init()
  });

  // this will listen to notifications
  apn.on('message', (message) => {
    console.log('notification: ', message);
    // do something with notification data
  });

Background Notification

The firebase-messaging-sw.js file is a service worker file used by Firebase Cloud Messaging (FCM) to handle the receiving and displaying of push notifications in the background, even when your web app is not currently open in the browser. Here’s how you can use it in your web projects:

  1. Create the Service Worker File: Create a new file named firebase-messaging-sw.js in the public folder of your project. The public directory is the root of your server, and the service worker file must be located at the root level to have control over all the pages of your site.
  2. Initialize Firebase in the Service Worker: In the firebase-messaging-sw.js file, you’ll need to initialize Firebase and the messaging service. Here’s a basic example:
// Import and configure Firebase
importScripts('https://www.gstatic.com/firebasejs/10.7.1/firebase-app-compat.js');
importScripts('https://www.gstatic.com/firebasejs/10.7.1/firebase-messaging-compat.js');

const firebaseConfig = {
 apiKey: "AIzaSy...",
 authDomain: "your-project-id.firebaseapp.com",
 databaseURL: "https://your-project-id.firebaseio.com",
 projectId: "your-project-id",
 storageBucket: "your-project-id.appspot.com",
 messagingSenderId: "sender-id",
 appId: "app-id",
 measurementId: "G-measurement-id",
};

// Retrieve an instance of Firebase Messaging
// so that it can handle background messages.
const messaging = firebase.messaging();

messaging.onBackgroundMessage((payload) => {
 self.registration.showNotification(notificationTitle,
   notificationOptions);
});

Methods in Arad

MethodInfo
init(firebaseConfig, vapidKey)initialize sdk width firebaseConfig (object) and vapidKey (string) promise
setKey(key)set a secretKey to ecnrypt configs void
checkConfig()check if configs defined and valid boolean
setConfig()set connection data void
getToken()return firebase token string (return null before initilize complete)

Methods in DeviceUtils

MethodInfo
getOs()returns OS name string
getBrowser()returns browser name string

Events

EventInfo
WakeUptrigger when a message received from firebase, here you should call apn.getMessage() apn.on('WakeUp', () => apn.getMessage())
MessageReceivetrigger when a message received from server, here you should handle and show message in your application apn.on('MessageReceive', (message) => handleNotification(message))

Keywords

FAQs

Package last updated on 30 Dec 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc