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

mongoose-ability

v1.0.0

Published

Mongoose plugin for managing users' abilities

Downloads

3

Readme

mongoose-ability

Mongoose plugin for managing users' abilities.

Build Status

How to install

npm install mongoose-ability

How to use

  1. Hook the plugin to a schema:
// user.js
const Promise = require('bluebird');
const { Schema, model } = require('mongoose');
const abilityPlugin = require('mongoose-ability');

const schema = new Schema({
  name: String
});

schema.plugins(abilityPlugin, {
  name: 'removeUser',
  verifier(user) {
    if(!user) {
      return Promise.resolve(true);
    }

    return Promise.resolve(this.equals(user));
  },
  error: new Error('Removing the user is forbidden by the user') // Define a custom error (optional)
});

verifier and name are required options for the plugin. name defines names of the methods generated by the plugin which are in format canActionName and canActionNameOrError. In example's case generated methods are canRemoveUser and canRemoveUserOrError. verifier is a function which verifies the ability by returning a promise which returns either true (action is permitted) or false (action is forbidden). verifier gets the same arguments as canActionName and canActionNameOrError methods. error is optional error parameter which will be rejected when using canActionNameOrError and action is forbidden.

  1. Validate abilities (Express example):
  const User = require('./user');

  app.delete('/users/:userId',
    authorize(),
    (req, res, next) => {
      let targetUser;

      User.findById(req.params.userId)
        .then(user => {
          if(!user) {
            return next(new Error(`Couldn't find user by id "${req.params.userId}"`));
          }

          targetUser = user;

          return req.user.canRemoveUserOrError(user); // rejects if verifier returns false
        })
        .then(() => targetUser.remove())
        .then(() => res.sendStatus(200))
        .catch(next);
    });

Running tests

npm test