vuestorefront / storefront-query-builder

ElasticSearch Query builder from the abstract "SearchQuery" object used by storefront-api, vue-storefront-api and vue-storefront projects

storefront-query-builder

Stay connected

ElasticSearch Query builder from the abstract "SearchQuery" object used by storefront-api, alokai-api and alokai projects.

The idea is, that the user can create the query in a pretty abstract way and get the ElasticSearch or potentially different query in return. Some nice extension ideas could be to add mongodb support or SQL support as well.

Example usage:

import { SearchQuery, elasticsearch } from 'storefront-query-builder'
import bodybuilder from 'bodybuilder'
const searchQuery = new SearchQuery()
searchQuery = searchQuery.applyFilter({key: 'parent_id', value: {'eq': 125 }})
const elasticSearchQuery = await elasticsearch.buildQueryBodyFromSearchQuery({ config, queryChain: bodybuilder(), searchQuery })
// send the `elasticSearchQuery` to ElasticSearch instance

More on storefront-api More on alokai

storefront-query-builder's Issues

filter by another field

Hi,
is it possible with this query builder to create filters that can compare with another field value?
like:

query.applyFilter({ key: 'special_price', value: { 'lt': "price" } })
query.applyFilter({ key: 'special_price', value: { lt: 'price.value' } })
query.applyFilter({ key: 'special_price', value: { lt: 'doc['price'].value' } })

None of above do work

Does query builder supports search attribute by text?

Hello!
Does query builder supports search attribute by text?

In vue storefront im using for example
ProductsQuery = ProductsQuery.applyFilter({ key: 'name', value: 'Test' })
And it doesn't return any item
Maybe I must add it to vsf-api schema (type=keyword)? rebuild db?

It generates
{ "query": { "bool": { "filter": { "terms": { "name": [ "Test" ] } } } } }

I checked in elasticvue manually - this request really return 0 items. What to do?

Add better distinction for the entity types

I feel that we should refactor how filters are applied and how search query is applied to distinguish the different data structures - eg. product vs category etc

searchScoring config values not applied

I was trying to change ES query properties like an idiot from config and seeing them not applied at all, when I found this

https://github.com/DivanteLtd/storefront-query-builder/blob/master/src/elasticsearch/score.ts

boost_mode, score_mode, max_boost, min_score are sough on config root while they are on config.elasticsearch.searchScoring.

Is this intended or just an oversight?
If not intended can I submit a PR?

Write unit tests

What to do:

• Install & configure JestJS
• Write unit tests with 100% coverage

Allow aggregations

While trying to use SearchQuery to build queries for custom entities, it does not provide a way for me to add aggregations to the queries. Previously when using bodyBuilder we were requesting aggregations on certain queries for custom entity types using query = query.aggregation('terms', 'ratings.value') for example (for reviews/ratings in this example). However, I can't accomplish this aggregation using SearchQuery.

I see that aggregations are added in the core code of SearchQuery to add aggregations under a very specific condition (specifically must be in 'catalog' scope), but there is no way to add our own aggregation requests.

Add extensibility features

It would be awesome if the users can extend the way we build queries (eg. adding new operators and transformations). The easiest way would be to give the developers a way to inject their own filter transformers/mappers to the: buildQueryBodyFromSearchQuery

missing `_appliedSort` when calling `buildQueryBodyFromFilterObject`

Here https://github.com/DivanteLtd/storefront-query-builder/blob/master/src/elasticsearch/index.ts#L77 needs to be added _appliedSort because right now it throws error. Also maybe we should add here https://github.com/DivanteLtd/storefront-query-builder/blob/master/src/types/SearchQuery.ts#L18-L21 fallback values? 🤔

    this._availableFilters = queryObj._availableFilters || []
    this._appliedFilters = queryObj._appliedFilters || []
    this._appliedSort = queryObj._appliedSort || []
    this._searchText = queryObj._searchText || []

Method to remove applied filters.

Hey Team,

let test = new searchQuery();
test.applyFilter({ filter values});

is there any specific method to remove the applied filter or empty the array later.

Thanks,

Use ES6 target instead of ES5

Hi team,

First of all, kudos to you all for contributing such an amazing library.

I am using it in Ionic 5/ Angular apps to generate elastic search queries. I noticed the following warning when using it

[ng] Warning: /xxxx.ts depends on 'storefront-query-builder'. CommonJS or AMD dependencies can cause optimization bailouts.
[ng] For more info see: https://angular.io/guide/build#configuring-commonjs-dependencies

I think if we build it as ES6 modules instead of ES5, we have the advantage of having tree shaking which can help to reduce the JavaScript payload.

WDYAT?