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

hapi-sanitize-payload

v3.0.0

Published

Hapi plugin to sanitize the request payload

Downloads

3,754

Readme

hapi-sanitize-payload

A plugin to recursively sanitize or prune values in a request.payload object.

Currently uses the following rules:

  • Removes null characters (ie. \0) from string values
  • Deletes from the payload keys with a value of empty string (ie. ''), or optionally replaces them with a different value
  • Deletes from the payload keys with a value consisting entirely of whitespace (ie. ' \t\n '), or optionally replaces them with a different value
  • Deletes whitespace from ends of string (ie. ' text ' becomes 'text')
  • Optionally deletes/replaces null values

Registering the plugin

const registerPlugins = async (server) => {
  await server.register([
    { plugin: require('hapi-sanitize-payload'), options: { pruneMethod: 'delete' } }
  ]);
};

Options

  • enabled - whether or not the plugin is enabled.
  • pruneMethod - the method the sanitizer uses when a value that is to be pruned is encountered. Defaults to 'delete'. The value must be one of:
    • 'delete' - the key will be removed from the payload entirely (ie. { a: '', b: 'b' } :arrow_right: { b: 'b' }).
    • 'replace' - the key will be preserved, but its value will be replaced with the value of replaceValue.
  • replaceValue - valid only when pruneMethod is set to 'replace', this value will be used as the replacement of any pruned values (ie. if configured as null, then { a: '', b: 'b' } :arrow_right: { a: null, b: 'b' }).
  • stripNull - a boolean value to signify whether or not null properties should be pruned with the same pruneMethod and replaceValue as above. Defaults to false.
  • fieldOverrides - an object where each key is a property and its value is an object of options (pruneMethod, replaceValue, and stripNull). The options value overrides the default options for that given property.
  • nestedOverrides - an object where each key is a property and its value is an object of options (pruneMethod, replaceValue, and stripNull). The options value overrides the default options applied to the nested object of that property. The default options for that property are considered the options after the fieldOverrides are applied.

Each of the above options can be configured on a route-by-route basis via the sanitize plugin object.

const registerRoutes = (server) => {
  server.route({
    method: 'POST',
    path: '/users',
    handler: () => {
      // handler logic
    },
    options: {
      plugins: {
        sanitize: { enabled: false }
      }
    }
  });
};

Setting up the server.

(async () => {
  try {
    const server = new Hapi.Server();

    await registerPlugins(server);
    registerRoutes(server);

    await server.start();
  } catch (err) {
    // Insert your preferred error handling here...
  }
)();