strongloop / loopback-filters

implements LoopBack-style filtering.

loopback-filters

⚠️ LoopBack 3 has reached end of life. We are no longer accepting pull requests or providing support for community users. The only exception is fixes for critical bugs and security vulnerabilities provided as part of support for IBM API Connect customers. (See Module Long Term Support Policy below.)

We urge all LoopBack 3 users to migrate their applications to LoopBack 4 as soon as possible. Refer to our Migration Guide for more information on how to upgrade.

Overview

This module implements LoopBack style filtering without any dependencies on LoopBack.

Install

$ npm install loopback-filters

Usage

Below is a basic example using the module

var applyFilter = require('loopback-filters');
var data = [{foo: 'bar'}, {bat: 'baz'}, {foo: 'bar'}];
var filter = {where: {foo: 'bar'}};

var filtered = applyFilter(data, filter);

console.log(filtered);

The output would be:

[{foo: 'bar'}, {foo: 'bar'}]

Features

Where

// return items where
applyFilter({
  where: {
    // the price > 10 && price < 100
    and: [
      {
        price: {
          gt: 10
        }
      },
      {
        price: {
          lt: 100
        }
      },
    ],

    // match Mens Shoes and Womens Shoes and any other type of Shoe
    category: {like: '.* Shoes'},

    // the status is either in-stock or available
    status: {inq: ['in-stock', 'available']}
  }
})

Only include objects that match the specified where clause. See full list of supported operators.

Geo Filter / Near

applyFilter(data, {
  where: {
    location: {near: '153.536,-28'}
  },
  limit: 10
})

Sort objects by distance to a specified GeoPoint.

Order

Sort objects by one or more properties.

Limit / Skip

Limit the results to a specified number. Skip a specified number of results.

Fields

Include or exclude a set of fields in the result.

Note: Inclusion from loopback is not supported!

Docs

See the LoopBack docs for the filter syntax.

Module Long Term Support Policy

This module adopts the Module Long Term Support (LTS) policy, with the following End Of Life (EOL) dates:

Version	Status	Published	EOL
1.x	End-of-Life	Dec 2017	Dec 2020

Learn more about our LTS plan in docs.

loopback-filters's Issues

Query nested properties

I'm not sure it's a bug or a new feature, but the behavior is not same as loopback find/findOne.

=== Sample Code ===

var applyFilter = require('loopback-filters');
var data = [
    {foo: [{name: 'bar'}, {name: 'bar2'}]},
    {bat: [{name: 'baz'}]},
    {foo: [{name: 'bar'}]}
];
var filter = {where: {"foo.name": 'bar'}};
var filtered = applyFilter(data, filter);
console.log(filtered);

=== Expected result ===

[ {foo: [{name: 'bar'}, {name: 'bar2'}] }, { foo: [{name: 'bar'} ]

=== Actual result ===

[]

but I use loopback model.find/findOne, I can get expected result.

Please help. Thanks.

5 requests per seconds?

mast 5 requests per seconds ? where can change the setting ?

Not working correctly

var applyFilter = require('loopback-filters');
datas = [];
for (var index = 0; index <= 10; index++) {
    datas.push({ id: index, title: 'hi ' + index});
}
var filter = {
    where: { id: { gt: 1, lt: 5 } },
    limit: 10,
    order: ['title DESC'],
    
};
var filtered = applyFilter(datas, filter);
console.log(filtered);

Results are WRONG!

There something wrong in Fields filter REST API

With introduce filter[fields][propertyName]=<true|false>



Do not add everything if some fields you don't want to see even a flase ?

The base case for pagination doesn't work properly

Description/Steps to reproduce

I've just created an array with 3 elements.

let input = [{index:0}, {index:1}, {index:2}]; 

Then I called the applyFilter function with the following parameters:

applyFilters(input, {skip:0, limit:1}); //It works properly. returns the element at index 0.

applyFilters(input, {skip:1, limit:1}); //Wrong response. It returns the element at index 1 and 2.

applyFilters(input, {skip:2, limit:1}); //It works properly. returns the element at index 2.

Inconsistency between documentation and implementation on fields filter

The fields filter in this library accepts array of field names where as the documentation says

{ fields: {id: true, make: true, model: true} }

`Regexp` and `ilike` filter operators

Bug or feature request

• Bug
• Feature request

Description of feature (or steps to reproduce if bug)

Loopback currently supports regexp and ilike operators for where filters, but I don't see support for that in this repo. Are there plans to add these two filter operators to this repository?

Thanks.

Expected result

const filterNodes = require('loopback-filters');
const data = [ { name: 'asd' }, { name: 'fAgh' }, {name: 'qwe'}, { name: 'jkAl' }];

filterNodes(data, { where: { name: { regexp: '/\w*[aA]\w*/i' } } }) // asd, fAgh, jkAl
filterNodes(data, { where: { name: { ilike: '%a%' } } }) // same

Add browser / bower support

This module is probably most useful in the context of a browser where:

• you have a loopback backend
• you want to further filter data from the backend using the same syntax as the filter you are sending to the server.

We should support:

• browserify require (almost certain this will just work)
• standalone umd style with global fallback (we can use browserify stand-alone for this)
• install via bower

/cc @bajtos @jtary @anthonyettinger @seanbrookes

`like` operation on `undefined` property is matched against string `"undefined"`

Around line 153, there is

return !!new RegExp(like).test(value);

this code gives false positive when value === undefined and like === /ne/ for example. The nlike case is analogical.

I will try to submit a fix soon.

CI failures for x64 and linux

see #7