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

mugs

v0.5.2

Published

Module for handling users

Downloads

28

Readme

How to run unit tests

smtp=smtps://username:[email protected]:465 npm test

ENV vars

Mandatory

  • appName: the application name, shown in e-mail.
  • appUrl: the root URL to the application, used to prefix the links sent in e-mails.
  • db: mongo URI for the user database.
  • smtp: smtps string for sending e-mails.
  • secret: secret used to issue and verify JWT tokens.
  • logoLink: URL to logo displayed in template.
  • redirectConfirmUrl: URL used for confirmation redirection. Will receive success query param, and message on failure.

Optional

  • rumor: trace level.

User model

{
	"id": MongoId,
	"email": String,
	"firstname": String,
	"lastname": String,
	"fullname": String,
	"password": String,
	"created": Date,
	"updated": Date,
	"confirmationToken": MongoId,
	"confirmed": Date,
	"resetPasswordToken": MongoId,
	"roles": [{ role: String, group: String }],
	"data": {},
}

Command line

You can sign a test user token with:

npm run sign -- [--secret <secret>] [--clean] [...roles]

Roles are space-separated roles on the role@scope form. secret is optional, and will default to ssh. The expiry period will be set to 7 days on creation. clean can be set to suppress adding default user roles.

Endpoints

POST /register

Perform a new user registration. Will add the default roles to the user, and result in an unconfirmed user.

Body

{
	"email": { type: String, required: true },
	"password": { type: String, required: true },
	"firstname": String,
	"lastname": String,
	"data": {},
}

Response codes

  • 200: New user registered
  • 400: Validation failure

GET /register/:token

Given a valid token, will confirm the user.

Params

  • token: the registration token that was e-mailed to the user.

Response codes

  • 200: Confirmation successful
  • 400: Invalid token

Success response

The request will succeed with a redirection to the redirectConfirmUrl, appending a query string ?success=true.

Failure response

The request will fail with a redirection to the redirectConfirmUrl, appending a query string ?success=false&message=[reason].

POST /

Perform an administrative user creation. Can only be performed by an admin@users. Will add the default roles to the user, and result in a confirmed user. A role array can be added, but the user posting will need to be admin of each of the scopes in the array.

Body

{
	"email": { type: String, required: true },
	"password": { type: String, required: true },
	"firstname": String,
	"lastname": String,
	"data": {},
	"roles": [{
		role: { type: String, required: true },
		scope: { type: String, required: true },
	}],
}