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

route-access-control

v1.1.0

Published

Simple role based access control which you can apply to API endpoints as middlewares or as a function inside handlers.

Downloads

6

Readme

Role Based Access Control

This module is used to implement role based access to API endpoints.

Create Role

Create a new role

const { Role } = require('./route-access-control)

const admin = new Role('admin');
const student = new Role('student');
const roleName = new Role('role-name');

Check Role

There are two ways to authorize roles

  1. Authorizing in the Middleware
  2. Authorizing inside route handler function

1. Middleware: checkRole

The middleware expects the claimed role to be inside req.role

  • Extract the requester role from the JWT token and store it in req.role

  • Use the Middleware checkRole(admin)

  • You can check for any number of roles: checkRole(admin, student, teacher)

  • The Middleware sends 401 Error if the role is not authorized

Example

The below route will only allow users with role admin

router.post('/protected', [checkJwt, checkRole(admin)], async (req, res, next) => {
	try {
		res.json('This is a protected route');
	} catch (error) {
		next(error);
	}
});

The below route will allow users with role admin or teacher

router.post('/protected', [checkJwt, checkRole(admin, teacher)], async (req, res, next) => {
	try {
		res.json('This is a protected route');
	} catch (error) {
		next(error);
	}
});

2. Function :isRoleAuthorized()

Use this inside your route handler

  • Returns a boolean

  • isRoleAuthorized(requesterRole, arrayOfAllowedRoles)

Example

router.post('/protected', checkJwt, async (req, res, next) => {
	try {
		const claimedRole = req.role;
		const allowedRoles = [admin];
		const isAuthorized = await isRoleAuthorized(claimedRole, allowedRoles);
		if (isAuthorized) {
			res.json('This is private route');
		} else {
			const message = 'User not authorized';
			res.status(401).json({ message });
		}
	} catch (error) {
		next(error);
	}
});