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

sails-hook-parsequery

v0.0.2

Published

Hook to parse query for Sails v1.0

Downloads

3

Readme

sails-hook-parsequery

A helper to parse request queries and params based on Sails Blueprints actions.

How to use

  • Parse a filter from query and params (inputs).
  • Process an action with the processed filter.

Filter

Action:

  • 'add',
  • 'create'
  • 'destroy'
  • 'find'
  • 'findOne'
  • 'populate'
  • 'remove'
  • 'replace'
  • 'update'
// api/controllers/some/action.js
...
fn: function(inputs, exits) {
  const model = 'user';
  const action = 'find';
  const filter = sails.helpers.parse.query(model, action, this.req.query, inputs);
  // ...
}

Action

// api/controllers/some/action.js
...
fn: function(inputs, exits) {
  const model = 'user';
  const action = 'find';
  const filter = sails.helpers.parse.query(model, action, this.req.query, inputs);
  const res = sails.helpers.actions[action](filter);

  return this.res.ok({list: res.list, count: res.count});
}

Error Handler

Use intercept/tolerate:

// api/controllers/some/action.js
...
fn: function(inputs, exits) {
  const model = 'user';
  const action = 'find';
  const filter = sails.helpers.parse.query(model, action, this.req.query, inputs)
    .intercept('badRequest', 'badRequest')
    .intercept('notFound', 'notFound');

  const res = sails.helpers.actions[action](filter)
    .intercept('notFound', 'notFound');

  return this.res.ok({list: res.list, count: res.count});
}

or use try/catch:

// api/controllers/some/action.js
...
fn: function(inputs, exits) {
  const model = 'user';
  const action = 'find';

  try {
    const filter = sails.helpers.parse.query(model, action, this.req.query, inputs);

    const res = sails.helpers.actions[action](filter);

    return this.res.ok({list: res.list, count: res.count});
  } catch (err) {
    sails.log.error(err);
    throw 'badRequest';
  }
}

Add

Request

Route: PUT /api/v1/users/:id/:association/:fk

PUT /api/v1/products/1/accessories
Autorization: Bearer {{jwtToken}}

{
  "id": 1,
  "association": 'pets',
  "fk": 2,
}

Actions

module.exports = {
  ...
  inputs: {
    id: {
      type: 'string',
      required: true,
    },
    association: {
      type: 'number',
      required: true,
    },
    fk: {
      type: 'string',
      required: true,
    }
  },
  fn: function(inputs, exits) {
    const filter = sails.helpers.parse.query('user', 'add', {}, inputs);
      .intercept('badRequest', 'badRequest')
      .intercept('notFound', 'notFound');

    const updatedUser = await sails.helpers.actions.add(filter)
      .intercept('notFound', 'notFound');

    return this.res.ok(updatedUser);
  }
};

Create

Request

POST /api/v1/products
Autorization: Bearer {{jwtToken}}

{
  "name": "iPhone",
  "price": 999.99
}

Actions

module.exports = {
  ...
  inputs: {
    name: {
      type: 'string',
      required: true,
    },
    pice: {
      type: 'number',
      required: true,
    }
  },
  fn: function(inputs, exits) {
    const query = {};
    const filter = sails.helpers.parse.query('product', 'add', {}, inputs);
      .intercept('badRequest', 'badRequest')
      .intercept('notFound', 'notFound');

    const res = await sails.helpers.actions.create(filter)
      .intercept('notFound', 'notFound');

    return this.res.ok(res);
  }
};

Find

Request

GET /api/v1/products?page=2&perPage=10

Actions

module.exports = {
  ...
  fn: function(inputs, exits) {
    const model = 'product';
    const query = this.req.query;
    const filter = sails.helpers.parse.query(model, 'find', query);
      .intercept('badRequest', 'badRequest')
      .intercept('notFound', 'notFound');

    const { list, count } = await sails.helpers.actions.find(filter)
      .intercept('notFound', 'notFound');

    // Response with count in header
    // this.res.set('X-Total-Count', count)
    // retrun this.res.ok(list);

    // Response with a nested object
    return this.res.ok({data: list, count});
  }
};