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

auto-crud

v0.2.8

Published

A simple tool for automatically generating REST APIs with json schemas and mongodb.

Downloads

17

Readme

autocrud({
    app: app,                   // The express application object.
    collection: mongo.hoosit,   // The collection object generated by the mongo driver.
    name: 'hoosit',             // The name of the object (this will be appended to the end of path).
    path: '/api',               // The root URL path that this API should be generated at.
    schema: {                   // The json schema that should be used for validation
        type: 'object',
        properties: {
            name: {type: 'string', required: true},
            description: {type: 'string'},
            rating: {type: 'integer'},
            comments: {type: 'array', items: {type: 'string'}}
        },
        additionalProperties: false
    }
});
autocrud({
    ... // Default options
    postTransform: function (body) {
        if (!body.rating) body.rating = 1;
    }
});

Transform functions take a single parameter, which is the message body after it has been validated.

  • defaultTransform If specified, this transform function will be applied to both POST and PUT operations.
  • postTransform If specified, this function will be used for POST operations, overriding the defaultTransform.
  • putTransform If specified, this function will be used for PUT operations, overriding the defaultTransform.
autocrud({
    ... // Default options
    defaultAuthentication: function (req, res, next) {
        if (req.isAuthenticated() && _.contains(req.user.roles, 'administrator')) next();
        else res.send(401, 'Unauthenticated');
    }
});
  • defaultAuthentication If specified, this middleware will by applied to all HTTP methods on the auto-curd route.
  • getAuthentication If specified, this middleware will be applied to the GET HTTP method. Overrides default.
  • postAuthentication If specified, this middleware will be applied to the POST HTTP method. Overrides default.
  • putAuthentication If specified, this middleware will be applied to the PUT HTTP method. Overrides default.
  • deleteAuthentication If specified, this middleware will be applied to the DELETE HTTP method. Overrides default.
autocrud({
    ... // Default options
    ownerIdFromReq: function (req) {
        return new ObjectID(req.user._id);
    },
    ownerField: 'owner'
});

NOTE: Both of the following fields must be provided for object ownership to be enabled.

  • ownerIdFromReq A function that extracts the user id value from the request object. This is passed as the first param.
  • ownerField The name of the field in each mongo document that holds the owner id.