UNPKG

bookshelf-jsonapi-params

Version:

Automatically applies relations, filters, and more from the JSON API spec to your Bookshelf.js results

126 lines (89 loc) 4.93 kB
# Changelog ### 1.6.3 (January 22, 2026) - Unlock lodash version to fix vulnerability ### 1.6.2 (November 12, 2025) - Do not add DISTINCT on subquery if there is a custom query passed in to the relationship, can possibly have ill efffects ### 1.6.1 (November 4, 2025) - Added DISINCT on subquery for included relationships using `fields` option ### 1.6.0 (March 16, 2022) - Added support for multiple `or` filters through use of a new `and` field ### 1.5.9 (July 23, 2021) - Fixed nullString for json filtering - Fixed issue with nullString for filter by not null ### 1.5.8 (July 15, 2021) - Replaced `.` with `_` for join tables relationship filters ### 1.5.7 (July 14, 2021) - Added support for specifying a different null string other than 'null' ### 1.5.6 (June 9, 2021) - Bumped lodash version, regenerated lock files ### 1.5.5 (May 13, 2021) - Allowing a string to be given for group, automatically converting it to an array of strings ### 1.5.4 (March 30, 2021) - Fixed bug for nesting `or` filtering with relationship filters. The joins for the relationships were not being added to the query. ### 1.5.3 (July 15, 2020) - Bug fix for aggregate functions ### 1.5.2 (April 28, 2020) - Allowed for bookshelf-page plugin from core in Bookshelf 1.* to be used, no longer overwriting the plugin. ### 1.5.1 (February 13, 2020) - Fixed bug for `or` filtering. Filters that were intended for `and` was switched to `or` when an or filter was present ### 1.5.0 (February 5, 2020) - Added support for `or` filtering ### 1.4.6 (January 30, 2019) - Added support for passing in an array for filtering (previous support was only comma separated string) ### 1.4.5 (January 27, 2020) - Fixed issue where including a relationship with a query build that did not have a select clause, did not select `*`, but intead only the required id columns ### 1.4.4 (January 23, 2020) - Fixed issue with belongsTo().through() where the foreign key is not set and a default key needs to be created ### 1.4.3 (January 23, 2020) - Fixed issue where `type` parameter was not being used - Fixed issue with selection columns on a relationship of type belongsTo().through() ### 1.4.2 (January 22, 2020) - Ensure the original options parameter does not get modified by deep cloning before processing ### 1.4.1 (January 21, 2020) - Updated README ### 1.4.0 (January 20, 2020) - Added ability to select fields on an included relationship n-levels deep by use of the `fields` parameter - Updated jsonb `like` filtering to support gin indexing ### 1.3.0 (December 23, 2019) - Changed 'like' queries to use ilike, for gin indexing support ### 1.2.0 (August 6, 2019) - Added support for JSONB filtering/sorting/selecting (Postgres only) - Extended tests to support postgres ### 1.1.3 (June 19, 2018) - Fixed issue with filtering by strings that contain quotes ### 1.1.2 (May 30, 2018) - Fixed bugs with formatting columns for database ### 1.1.1 (April 24, 2018) - Fixed bugs with "null or" filtering ### 1.1.0 (April 23, 2018) - Added filtering for null and not null values - Fixed relation filtering query bugs ### 1.0.0 (December 8, 2017) - Support for filtering on n-level deep relationships - Support for sorting on n-level deep relationships - Support for filtering operators (like, gt, gte, lt, lte, not) ### 0.6.2 (June 13, 2016) - Resolves an issue where sorting on a multi-word column name (ex: startsAt) doesn't work properly. ### 0.6.1 (June 13, 2016) - Botched NPM publish. Use 0.6.2. ### 0.6.0 (June 10, 2016) - Reverted previous ability to pass in your own `withRelated` options as it was stupid and more complicated than it needed to be. Instead, you can just override the `include` parameter to be a Knex function with the relationship name as the key. ### 0.5.0 (June 2, 2016) - Added the ability to pass in your own `withRelated` options to Bookshelf and have it override a relation with the same name that was passed via `include`. This is useful when you may need to do something with a relation that is out of the realm of Bookshelf's defaults. - Dependency updates ### 0.4.0 (May 10, 2016) - Merged PR [#10](https://github.com/scoutforpets/bookshelf-jsonapi-params/pull/10) to fix [#9](https://github.com/scoutforpets/bookshelf-jsonapi-params/issues/9) - Dependency updates - Added badges ### 0.3.3 (April 28, 2016) - Fixed an issue where multiple filters were not applied properly ### 0.3.3 (April 28, 2016) - Fixed an issue where multiple filters were not applied properly ### 0.3.2 (April 28, 2016) - Botched release! Upgrade to 0.3.3 immediately! ### 0.3.1 (April 27, 2016) - Fixed an issue where ambiguous columns could cause an error ### 0.3.0 (April 16, 2016) - Added tests/documentation on disabling paging for a specific call. ### 0.2.0 (April 14, 2016) - [#4](https://github.com/scoutforpets/bookshelf-jsonapi-params/pull/5) [BUGFIX/ENHANCEMENT] Removes unreliable, automatic detection of collections.