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

access-control-list-module

v1.1.6

Published

an ACL (Access Control List) specifies which users are granted access to objects,

Downloads

10

Readme

Access Control List Module

ACL (Access Control List) specifies which group of users are granted access to objects, as well as what operations are allowed on given objects.

###Note

The module is currently under continuous development, and lots of new features will be added continuously

###Where the roles are being saved?

Roles are saved on a file in the server file system, in order to make the roles and its permissions persistent.

Installing

Just download the package from your terminal

npm i access-control-list-module

###To Create New Role: A user role can be defined by calling a createRole method on the module

createRole('admin');
createRole('guest');

###To Set Permissions: Permissions should be defined using functions a and an, like so:

an('admin').can('post').to('/users');
a('guest').can('get').from('/users');

You can also set conditional permissions based on parameters in the path you set permission for using the when function:

a('user').can('post').to('/users/:userId/articles').when((params, user) =>
user.id === params.userId);

The when function always receives a an object params as a first parameter. The params object holds values for defined URL parameters.

###To check Permissions:

check.if('admin').can('post').to('/users'); //true

When checking using the when function you don't need to send the params, you only need to send the other arguments that you have set to when function while setting the permissions for that path

check.if('user').can('post').to('/users/10/articles').when({ id: 10 });

###To clear ALL Roles:

clearAllRoles();

Getting Started

Just try this example

//require module

const {createRole,a,an,check,clearAllRoles}=require('access-control-list-module');

// create different roles

createRole('admin');

createRole('user');

createRole('guest');

// admin can list all users

an('admin') .can('get') .from('/users');

// admin can create users

an('admin') .can('post') .to('/users');

// user can post an article only when it's his data

a('user') .can('post') .to('/users/:userId/articles') .when((params, user) => user.id === params.userId);

// guest can get data from articles

a('guest') .can('get') .from('/articles');

//checking

console.log( check .if('guest') .can('post') .to('/users') ); // false

console.log( check .if('admin') .can('post') .to('/users') ); // true

// check if a user can post to /users/10/articles

console.log( check .if('user') .can('post') .to('/users/10/articles') .when({ id: 10 }) ); // true

// check if a user can post to /users/articles

console.log( check .if('user') .can('post') .to('/users/articles') ); // false

clearAllRoles(); //to clear the fake saved test rules from the server