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});
  }
};