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

sf-auth

v0.6.1

Published

User Management Library for Express.js apps

Downloads

3

Readme

Chaos Authorization Library

Performs all basic authentication tasks, provides organization => users hierarchy and simple express app integration

Usage

const r = require('rethinkdbdash')({ db: 'chaos' });

const settings = {
  secret: 'MY_SUPER_DUPER_SECRET_HASH',
  site: {
    name: 'Some Cool Site',
    url: 'http://localhost:3000'
  },
  email: {
    from: "[email protected]",
    host: "mail.somewhere.com",
    user: "[email protected]",
    password: "foobar",
    ssl: true
  }
};

const auth = require('chaos-auth')(r, settings);

const app = express();
app.use(cors());
app.use(bodyParser.json())
   .use(bodyParser.urlencoded({ extended: false }));

app.use('/auth', auth.router);
app.get('/test', auth.authorize, (req, res) => {  
  res.send({ success: true, message: 'i am authorized' });
});

Available Middleware

authorize

authorizes JWT token, builds Authorization Object under req.auth

app.get('/custom_endpoint', auth.authorize, (req, res) => {
  // available only for authorized requests
  console.log('logged in with token', req.auth.token);
  res.send({
    user: req.auth.user,
    organization: req.auth.organization
  })
});

requireSuperuser

app.get('/custom_endpoint', auth.authorize, auth.requireSuperuser, (req, res) => {
  // available only for superuser
});

requireAdmin

app.get('/custom_endpoint', auth.authorize, auth.requireAdmin, (req, res) => {
  // available only for admin
});

Available REST endpoints

POST /register

registers user account and sends confirmation email, until user confirms the account the user has

{
  "user": { 
		"email": "[email protected]",
		"password": "foobar",
		"passwordConfirmation": "foobar",
		"firstName": "John",
		"lastName": "Doe"
	},
	"organization": {
		"name": "Foobar ltd",
		"email": "[email protected]",
		"country": "Finland"
	}
}

you can add your own attributes as long as it's not "id", "createdAt", "updatedAt", "perishableToken"

GET /activate?token=TOKEN&redirect_to=SOMEWHERE

activates the account using perishable token, then redirects to supplied link

POST /login

creates a session and returns Authorization Object with User, Organization and Token

{
  "email": "[email protected]",
  "password": "foobar"
}

POST /admin/login [JWT] [ADMIN]

creates a session using different organization

{
  "organization_id": "abcdefgh"
}

GET /logout [JWT]

deletes the current token

GET /password_reset

sets perishable token and sends password request confirmation email

GET /password_reset_confirmation?token=TOKEN&redirect_to=SOMEWHERE

generates random password, sends email to user and redirects to provided link, uses perishable token

POST /password_change [JWT]

changes password of user

{
  "currentPassword": "foobar",
  "newPassword": "foobar2"
}

GET / [JWT]

returns Authorization Object with User, Organization and Token for current session

POST /users [JWT] [SUPERUSER]

allows superuser to create other users under the same organization

{ 
  "email": "[email protected]",
  "password": "foobar",
  "passwordConfirmation": "foobar",
  "firstName": "John",
  "lastName": "Doe"
}

PUT /users/:id [JWT] [SUPERUSER]

allows superuser to modify other users under the same organization

{ 
  "email": "[email protected]",
  "password": "foobar",
  "passwordConfirmation": "foobar",
  "firstName": "John",
  "lastName": "Doe"
}

Template customization

you can use your own email templates and mail subjects by setting following properties in settings objects templates are standard handlebar templates using {{ variable }} style. Check builtin templates for available properties.

var fs = require('fs');

var settings = {
  emails: {
    confirm: {
      subject: "Confirm your email!",
      template: fs.readFileSync('./templates/confirm.html')
    }
  }
}

Testing

Tests will run their own express api server using this library. Email sending tests are not yet implemented.

  npm run test