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

opuntia-mongo

v0.6.2

Published

A plugin for 'opuntia' framework for using it with MongoDB

Downloads

2

Readme

opuntia-mongo. Store your data in MongoDB.

A plugin for 'opuntia' framework for using the it with MongoDB Overrides opuntia.Server class. Contains three modules: auth, users, info Used collection names (hardcoded now): users, sessions, counters, logs

Module Auth - Autorization

Implements opuntia auth interface (method async checkAuthorized(r)). That allows use it as parameter in opuntia router. Exports a router to with some endpoints (login, logout, info) too handle authorization requests. Settings:

  • LOCAL_ID_LENGTH - localCounter length in bits. Default 20. 0 - do not generate id_seed
  • TOKEN_LENGTH - auth token length in bytes. Default 16.
  • COOKIE_NAME - cookie for token name

Module Users - User List

Allows to handle a common user list located in users collection. Settings:

  • MIN_PASSWORD_LENGTH - default 6
  • ENCRYPT_PASSWORD - default true

Module Info - Database Info

Exports some methods to get an information about the database. Mostly for development.

On-the-Client ID Generation

Requirements:

  • ID should be numeric for data volume minimization
  • ID could be generated on the client without the backend connection
  • ID can't exceed 53 bit number because of JavaScript features (ECMA Section 8.5 - Numbers)

Solution:

globalCounter(53-n bit) : localCounter(n bit) The backend keeps a global counter (auto-increment sequence). Each successful login generates and sends to the client an id_seed = globalCounter<<n. The client generates ID like: id_seed + localCounter (where localCounter is a local auto-increment sequence).


Usage Example

const opuntiaMongo = require("opuntia-mongo");
let auth  = opuntiaMongo.auth;
let info  = opuntiaMongo.info;
let users = opuntiaMongo.users;
// Modify settings
auth.settings.TOKEN_LENGTH    = 8;
auth.settings.LOCAL_ID_LENGTH = 2;
users.settings.MIN_PASSWORD_LENGTH = 4;

let router = {
    // Private part
    portal: {	
        // Parameters
        ...
		_database:	mongo.db("portal"), // mongo - connected MongoDB client
        _auth: auth,
        // Branches
        auth:  auth.router, // handle requests /portal
		users: users.router,
		info:  info.router,
        ...
    }
}
new opuntiaMongo.Server(router).server.listen();

A working example is in 'test' folder of the project repository