CHANGELOG.md

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

3.23.0 (2025-01-14)

Features

• composition (#6437) (cee83ab)

3.22.6 (2024-12-09)

Bug Fixes

• disjunctive: prefer values of main query for facet count (#6445) (9bc841a)
• insights: ensure the same token is used when rendered multiple times server side (#6456) (c3a1c70)

3.22.5 (2024-09-10)

Bug Fixes

• client: use client.search in sffv for v5 (#6354) (11399e6)

3.22.4 (2024-08-20)

Bug Fixes

• client: support v5 fully (#6270) (c3b5e80), closes #6271 #6286

3.22.3 (2024-07-16)

Bug Fixes

• cache: support nested hierarchical refinements (#6283) (8a0ae01)

3.22.2 (2024-07-02)

Bug Fixes

• algoliasearch: v5 does not default threshold to 0 (#6251) (762e633)

3.22.1 (2024-06-20)

Bug Fixes

• helper: don't send empty "tagRefinements" and "facets" parameters (#6204) (fb7cc23)
• types: make algoliasearch detection compatible with TS 5.4.5 (#6244) (4a7afc3), closes #5989

3.22.0 (2024-06-18)

Features

• facets: allow hiding values through renderingContent (#6239) (b7eef90)
• infinite-hits: return banner info with connectInfiniteHits (#6230) (0d50f0d)

3.21.0 (2024-05-28)

Features

• recommend: enable server-side rendering (#6215) (21404fc)

3.20.0 (2024-05-21)

Features

• recommend: cache results per $$id (#6181) (c0f4802)
• recommend: enable multiple objectIDs in connectors (#6176) (ffe6a1c)
• recommend: handle multiple objectIDs for one widget (#6160) (f6a1c1c)
• recommend: map recommend results to widgets (a5a87dd)

3.19.0 (2024-04-30)

Features

• hits: return banner from connectHits (#6130) (5bde60d)

3.18.0 (2024-04-18)

Features

• helper: add methods to request and retrieve recommendations (#6111) (1b683c5)

3.17.0 (2024-04-02)

Features

• helper: set up state management for recommendations (#6100) (bc5122f)

3.16.3 (2024-02-27)

Bug Fixes

• helper: correctly set isRefined for hierarchical facet values with trailing spaces (#6059) (a12e567)

3.16.2 (2024-01-23)

Bug Fixes

• perf: improve speed of setQueryParameters (d1aa720)
• requestBuilder: sort facet refinements in a non-mutating manner (#6012) (31dbf87), closes #5764

3.16.1 (2023-12-19)

Note: Version bump only for package algoliasearch-helper

3.16.0 (2023-12-07)

Features

• hierarchical-menu: persist refined root level count with a future flag (#5950) (79ee485)

3.15.0 (2023-10-24)

Features

• instantsearch: allow the insights middleware to be added in answer to a server setting (#5883) (2a9e654)

3.14.2 (2023-09-19)

Bug Fixes

• prettier: consistent version (#5850) (ca59c6d)

3.14.1 (2023-09-12)

Note: Version bump only for package algoliasearch-helper

3.14.0 (2023-07-25)

Features

• caching: sort filters and queries (#5764) (f3d2019)

3.13.5 (2023-07-19)

Bug Fixes

• version: ensure version file/export matches package (#5762) (eb0bb32)

3.13.4 (2023-07-18)

Note: Version bump only for package algoliasearch-helper

3.13.3 (2023-06-21)

Bug Fixes

• getFacetValues: ignore rootPath for hierarchical facets (#949) (deb5daf)

3.13.2 (2023-06-14)

Bug Fixes

• types: improve conditional for client version (#943) (6c22185)

3.13.1 (2023-06-12)

Bug Fixes

• SearchResults: use empty facets object for exclusion when results are artificial (#940) (a51e8cb)

3.13.0 (2023-05-03)

Features

• DerivedHelper: skip request for empty index (#938) (79caa4b)

3.12.0 (2023-03-03)

Features

• types: add queryAfterRemoval to SearchResults (#934) (4fb5a03)

3.11.3 (2023-01-23)

Bug Fixes

• getFacetValues: reflect the value of _state in hierarchicalFacetValues (#925) (4d093b4)

3.11.2 (2023-01-09)

Bug Fixes

• answers: deprecate findAnswers (#919) (0711861)
• prevent prototype pollution in rare error-cases (#923) (7ae16ea), closes #922 #880

Features

• update Algolia logo (#918) (58e0e58)

3.11.1 (2022-09-12)

Bug Fixes

• facetValues: use existing facet filters in multi queries for hierarchical facet values (#915) (bae388c)

3.11.0 (2022-08-03)

Features

• typing: Update SearchResults hits, expose optional hit typings (#914) (bf4c4c6)

3.10.0 (2022-06-27)

Features

• disjunctiveFacetParams: reduce payload size (#912) (9518575)
• types: support algoliasearch v5 (#910) (524272a)

3.9.0 (2022-06-20)

Bug Fixes

• requests: send a sorted object of parameters (#911) (832507f)

Features

• searchForFacetValues: fall back to client.search if it's present (#906) (d9ebb01), closes /github.com/algolia/algoliasearch-client-javascript/blob/v3/src/AlgoliaSearchCore.js#L638-L654

3.8.3 (2022-06-15)

Bug Fixes

• facetValues: retrieve all hierarchical facet parent values (#908) (420111b)

3.8.2 (2022-04-08)

Bug Fixes

• types: correct type for addTag (#903) (ca82ef3)

3.8.1 (2022-04-05)

Bug Fixes

• disjunctiveFacets: avoid escaping non-string values (#902) (4ac67bd)

3.8.0 (2022-04-04)

Features

• facetValues: offer escaped value (#889) (4bae51b), closes #900 #901

3.7.4 (2022-03-21)

Bug Fixes

• type: implement correctly (1c8670b)

3.7.3 (2022-03-18)

Bug Fixes

• ts: remove stray comment (24fe8de)

3.7.2 (2022-03-18)

Bug Fixes

• results: implement search result options via an argument (4e6ac69)

3.7.1 (2022-03-17)

Bug Fixes

• types: allow "__isArtificial" (#890) (1e2aef0)

3.7.0 (2021-12-13)

Features

• events: move to @algolia/events (#883) (0c33fdc)

3.6.2 (2021-10-19)

Bug Fixes

• SearchParameters: ignore invalid parameters (#880) (4ff542b)

3.6.1 (2021-10-15)

Bug Fixes

• facetOrdering: make sure ordered facets is a dense array (#879) (990f8bc)

3.6.0 (2021-10-08)

Features

• facets: when * is present, only send that parameter (#874) (fc183ec)

3.5.5 (2021-07-30)

Features

• ts: allow showParentLevel in hierarchicalFacet (cef547d)

3.5.4 (2021-07-05)

Bug Fixes

• facetOrdering: facetOrdering.facets, not facetOrdering.facet (97d769a)

3.5.3 (2021-06-14)

Bug Fixes

• ts: correct required for getFacetValues (55a909f)

3.5.2 (2021-06-14)

Bug Fixes

• facetOrdering: hierarchical attributes sort by path (c1d9764)

3.5.1 (2021-06-14)

Bug Fixes

• ts: correctly optional renderingContent (41d27f8)

3.5.0 (2021-06-14)

Features

• getFacetValues: process facetOrdering (#822) (8c7ff44)

3.4.5 (2021-06-10)

Features

• ts: document renderingContent (#823) (7b176a7)

3.4.4 (2021-02-16)

Bug Fixes

• ts: add rootPath to HierarchicalFacet (06fb959)

3.4.3 (2021-02-15)

Bug Fixes

• ts: correct type for HierarchicalFacet parameter (#811) (3b705dd), closes /github.com/algolia/instantsearch/blob/1ede1ae392d3a12f5b0fe29075ffeb05e572a874/src/connectors/menu/connectMenu.js#L283-L286 /github.com/algolia/instantsearch/blob/1ede1ae392d3a12f5b0fe29075ffeb05e572a874/src/connectors/menu/tests/connectMenu-test.js#L98-L101

3.4.2 (2021-02-10)

Bug Fixes

• types: add relevancyStrictness to SearchParameters (#810) (3860179)

3.4.1 (2021-02-10)

Bug Fixes

• ts: add types for smart sort (#809) (236822e)
• ts: make queryID optional (#806) (67ad89b)

3.4.0 (2021-01-12)

Features

• answers: add findAnswers (#804) (4635dd5)

3.3.4 (2020-12-09)

Bug Fixes

• ignore invalid userToken (#802) (a2876c5)

3.3.3 (2020-12-02)

Bug Fixes

• removeNumericRefinement: clear empty refinements (#801) (844f7d7)

3.3.2 (2020-11-19)

Bug Fixes

• ts: add queryLanguages to parameters (51f5448)
• ts: add searchWithoutTriggeringOnStateChange (fb91e27)
• ts: correct type for clearCache (684d5c0)
• ts: detailed type for facet.stats (234cb19)

3.3.1 (2020-11-19)

Bug Fixes

• setup: run postinstall only locally (9df09e4)

3.3.0 (2020-11-19)

Bug Fixes

• ts: correct type for getNumericRefinements (#800) (0920d94)

Features

• ts: fill in more of the types (34ae5cd)

3.2.2 (2020-07-30)

Bug Fixes

• insideBoundingBox: prevent invalid parameter from throwing (#787) (ba5ef68)
• ts: use a dedicated key to determine client version (#789) (deb4f4f)

3.2.1 (2020-07-23)

Bug Fixes

• defaultsPure: fix the regression where the order was wrong with addFacetRefinement (#786) (b54fddb)

3.2.0 (2020-07-21)

Bug Fixes

• accept all fields implicitly instead of the allow list (#779) (89a7aab)

3.1.2 (2020-06-02)

Bug Fixes

• defaultsPure: don't change keys order, fix #761 (#762) (6b835ff)
• types: add resetPage state method (#773) (e2a88a1)
• typescript: fix TypeScript 3.9 compatibility (#775) (c83c501), closes #774

3.1.1 (2020-02-21)

Bug Fixes

• fix omit calls to pass excluded value as an array (#760) (dd375ab)

3.1.0 (2020-01-21)

Bug Fixes

• types: add optionalFilters search parameter (#754) (faba4d7)

Features

• algoliasearch: add support for algoliasearch v4 the helper v3 (#756) (67407a0)

3.0.0 (2019-11-18)

Bug Fixes

• defaults: remove const (48a0c48)
• errors: remove isRefined (#731) (5761885)
• getConjunctiveRefinements: no error when requested facet is not conjunctive (#724) (cf852e7), closes #722
• getDisjunctiveRefinements: remove error (#725) (211e390), closes #722
• getExcludeRefinements: replace error by default value (#726) (9d7ae87)
• getFacetStats: remove error (#721) (96b6ec8), closes #720
• getFacetValues: don't throw error when there's no facet (#720) (e15e39e)
• getHierarchicalFacetBreadcrumb: don't throw an error (#723) (40e1d61)
• isDisjunctiveFacetRefined: return false if not in disjunctiveFacets (#729) (13ec09b), closes #727
• isExcludeRefined: remove error in favor of false (#728) (3f0ab6b), closes #727
• isFacetRefined: return false if facet isn't declared (#727) (7151f56)
• isHierarchicalFacetRefined: return false if refinement isn't a facet (#730) (89fa010), closes #722
• lodash/intersection: replace with custom implementation (#718) (00dfb4e), closes #696
• removeXFacet: make sure this fully removes empty arrays (#743) (ea5a22a)
• results: remove lodash looping over objects (#648) (bb025c2), closes #258 #651
• sortBy: compare whole prefix instead of first character (#702) (b85fb50), closes /github.com/algolia/algoliasearch-helper-js/pull/690#discussion_r282467917
• toggleRefinement: keep an empty array when clearing (#738) (5b3fc11)
• types: add state.removeNumericRefinement (#742) (e58c24a)

Features

• getState: remove "filter" option (#707) (ac52791)
• getState: remove getState (#708) (7de698c)
• implement dedicated reset page method (#673) (666501e)
• requestBuilder: prevent needless extra requests for empty refinements (#737) (db0a392)
• search: allow the search only with Derived Helpers (#704) (aa128fc)
• SearchParameters: avoid undefined values (#703) (9757e0a)
• typescript: move typings inline (#719) (a12272e), closes /github.com/algolia/algoliasearch-helper-js/pull/719/files#r301510978 /github.com/algolia/algoliasearch-helper-js/pull/719#commitcomment-34233548

BREAKING CHANGES

• errors: removed helper.isRefined, use helper.hasRefinements instead

• getState: use helper.state instead of helper.getState()

• getState: getState(filters) is replaced my manually filtering the returned object

• getState: SearchParameters.filter is removed

• doc(filter): remove reference

2.28.0 (2019-05-07)

Bug Fixes

• ua: change the User-Agent to use the new specs lib (version) (#647) (eafd4cf)

Features

• sffv: throw an error if it's called and the client doesn't have the functions (#623) (dd61360)

2.26.1 (2018-06-19)

Bug Fixes

• _dispatchAlgoliaResponse: avoid mutate the client response (#611) (d6bd801)

2.26.0 (2018-04-25)

Features

• Make addAlgoliaAgent() and clearCache() optional (#577) (220b013)

2.25.1 (2018-04-20)

Bug Fixes

• sffv: unwrap content when it comes from multi queries (#574) (fcb15d4)

2.25.0 (2018-04-18)

Features

• search: Promisify client.search() (#571) (d12cbda)
• sffv: Use client SFFV over index SFFV (#572) (bb17720)

2.24.0 (2018-01-31)

Features

• make Helper ready for insights (03f8f31)

2.23.2 (2017-12-14)

Bug Fixes

• release-script: actually build the library (#559) (421ec70)

2.23.1 (2017-12-12)

Bug Fixes

• url: treat insideBoundingBox in float form as number (#554) (3a7423e), closes #553

2.23.0 (2017-10-18)

Bug Fixes

• events: only trigger change when there is an actual change (#546) (80f9724)

Features

• sffv: can override search when using searchForFacetValues (#549) (55c2e75)

2.22.0 (2017-10-09)

Bug Fixes

• FacetValue doc: wrong attribute name in docs (#539) (7275a75), closes /github.com/algolia/algoliasearch-helper-js/blob/master/src/SearchResults/index.js#L541-L548
• requestBuilder: set analytics:false to subsequent queries (#543) (ebf41d9), closes #540
• setState: use .make() instead of constructor() (#542) (173da7c)

Features

• query rules: expose userData (#544) (2f93520), closes #529

2.21.2 (2017-07-27)

Bug Fixes

• SearchResults: add exhaustiveNbHits and exhaustiveFacetsCount (fad31fb), closes #489

2.21.1 (2017-07-20)

Bug Fixes

• events: We need searchEmptyQueue before result to avoid inconsistency (4c58b0f)
• pending-search: dispatch error event before searchQueueEmpty (#503) (30e3f07)
• url: When there are no "other attributes" should not render last & (#517) (f376ff2)

2.21.0 (2017-07-08)

Bug Fixes

• events: events for all kinds of searches (b960fee), closes #513

2.20.1 (2017-03-11)

Bug Fixes

• build: Remove es2015 module (#487) (0896a65), closes #486

2.20.0 (2017-03-10)

Features

• maxFacetHits: implement maxFacetHits for SFFV (643c29a), closes #480
• pending-search: let the dev know the state of the search requests queue (c5b39d2)

2.19.0 (2017-03-06)

Features

• search-response: Exposed raw results (8d4f938)

2.18.1 (2017-02-14)

Bug Fixes

• agent: sets the helper agent once (#474) (c94cac5), closes #473
• toggleRefinement: rename toggleRefinement to toggleFacetRefinement (6700f98), closes #447

2.18.0 (2017-01-10)

Features

• client: Adds methods to set/get the client. (#460) (2ddd7ec)

2.17.1 (2016-12-28)

Bug Fixes

• agent: Add a test if addAlgoliaAgent exists (#455) (0ab4e31)

2.17.0 (2016-12-22)

Bug Fixes

• doc: fix deep object documentation. (#450) (6e3146e), closes #443

2.16.0 (2016-12-06)

Features

• searchForFacetValues: implement a new method to be able to search into facet values (#423) (8e2a5bb)

2.15.0 (2016-11-22)

2.14.0 (2016-09-09)

Features

• hierarchicalFacets: add add and remove operations on hierarchical facets (519d359), closes #250

2.13.0 (2016-08-24)

Bug Fixes

• excludes: conjunctive facets results report exclusions (0f3f844)

Features

• add-remove-facet: add methods to add and remove facets from SearchParameters configuration (#330) (fd0e777)
• add-remove-facet: add methods to add and remove facets from SearchParameters configuration (#333) (f14dbbf)
• no-set-page: don't reset the page to 0 in SearchParameters methods (64a116e), closes #343
• SearchResults: backport instantsearch.js getRefinement method (e3a3238), closes #195

BREAKING CHANGES

• no-set-page: SearchParameters methods don't reset the page to 0 anymore.

2.12.0 (2016-07-22)

2.11.1 (2016-07-20)

2.11.0 (2016-06-22)

Features

• urls: provide a safe option to fully encode the url (3ef6ae1)

2.10.0 (2016-06-10)

Performance Improvements

• deepFreeze: Removing the calls to deepFreeze (3a515b8), closes #301 #301

2.9.1 (2016-03-16)

Bug Fixes

• filterState: handle hierarchical facet attributes (5bfdceb)

2.9.0 (2016-02-19)

Bug Fixes

• numeric filters: Makes it possible to add then remove a string based numeric filter (8b2bb97)
• numeric filters: Makes it possible to add then remove a string based numeric filter (d849f0b)
• pagination: adds doc on reset behavior, changes the name of setter (ec70c8b)

Features

• url: new mapping option for URL methods (7d93cac)

2.8.1 (2016-02-01)

Features

• add snippetEllipsisText, disableExactOnAttributes, enableExactOnSingleWordQuery (c6af7af)

2.8.0 (2015-12-11)

Bug Fixes

• algoliasearch.helper: fixes optionalTagFilters & optionalFacetFilters jsdoc (e08ad78)
• hierarchicalFacets: ensures the order of the hierarchical facets matches the order of the declared hierarchical attributes to avoid (silent) failures when the API returns JSON with unordered facets (8a326cc)
• search-results: adds missing results parameters (1c4908a)

2.7.0 (2015-12-02)

Bug Fixes

• core: makes node dependencies explicit (d532bc9)
• request-builder: Makes queries less ambiguous for client fix #205 (9915c2f)

2.6.9 (2015-11-24)

Bug Fixes

• hierarchical: exclude facet when the rootPath equal to the facet value (42d386a)

2.6.8 (2015-11-24)

Features

• hierarchical: add prefix path option to hierarchical facet (10ee69e)
• hierarchical: finish rootPath and add showParentLevel options to the hierararchical facets) (f27af29)

2.6.7 (2015-11-17)

Bug Fixes

• hierarchicalWidget: Error when faceted and no results (6a6c554)

2.6.6 (2015-11-04)

Bug Fixes

• removes window dependency (b6c5043)
• SearchParameters: parses all numeric attributes (4a8e770)

2.6.5 (2015-11-03)

Bug Fixes

• hierarchical: refined + no result (d0337d3)

2.6.4 (2015-11-02)

Bug Fixes

• hierarchical: reset pagination to 0 when refining (e1193ef)

2.6.3 (2015-10-19)

2.6.2 (2015-10-16)

2.6.1 (2015-10-15)

Features

• SearchParameters: toggleRefinement on SearchParameters (ac71495)

2.6.0 (2015-10-15)

2.5.1 (2015-10-12)

Bug Fixes

• facetStats: a facet can be both in facets & disjunctiveFacets (458a694), closes #228

2.5.0 (2015-10-09)

2.4.0 (2015-09-23)

Bug Fixes

• avoid using console.error in IE8/9 when not available (c4c6127)

2.3.6 (2015-09-17)

Bug Fixes

• IE8 has no Array.indexOf (4724048)

2.3.5 (2015-09-11)

Bug Fixes

• getFacetStats should look in both facets, disjunctiveFacets (95aa9b8)

2.3.4 (2015-09-11)

2.3.3 (2015-09-09)

Bug Fixes

• defaultNumericRefinement is an object not an array (cf17d55)
• hasRefinements should look for every type of refinement (acb2719), closes #204

2.3.2 (2015-09-04)

Bug Fixes

• accepts length parameter by fixing searchParameters iteration (a6a9e53)

2.3.1 (2015-09-02)

Bug Fixes

• add undocumented offset and length params (87fdb81)
• throw when unknown parameter (8c97080)

2.3.0 (2015-09-02)

Bug Fixes

• typo (4979da2)

2.2.0 (2015-07-29)

Bug Fixes

• bad results computation when alwaysGetRootLevel (44e18d4)
• change the default hierarchical facet behavior (01cb48d)
• clear hierarchical refinements appropriately (992d677)
• edge case on toggleRefine hierarchical facet (95ab755)
• eslint fixes in hierarchical faceting (14db531)
• getFacetByName for hierarchical facets (81829fc)
• handle multiple hierarchical facets (b41b6a5)
• handle objects with multiple categories values (b81c17b), closes #163
• handle toggleRefine on a different parent leaf than the current one (6734971)
• hierarchical alwaysGetRootLevel count was bad (cf595ea)
• hierarchicalFacets toggleRefine on parent should not refine parent (4639cbf), closes #164
• hierarchicalFacetsRefinements is now an array (762b588), closes #160
• isDisjunctiveRefined() and isRefined() return true/false (1bb31a3), closes #123
• isDisjunctiveRefined() and isRefined() return true/false (2d9edd9), closes #123
• params are optional right? (5f43031)
• stop triming facet filters values automatically (8c67bb5)
• throw on unknown hierarchical facet (5df3397)
• toggleRefine on root level of a hierarchical refinement (47ecdfe)
• use setQueryParameters() instead of mutateMe (4fc3df9)
• wrong facetFilters on disjunctive + hierarchical facet (88df8c5), closes #161

Features

• add alwaysGetRootLevel option (dd97d98)
• add hierarchical facet sortBy option (04254c7)
• hierarchical facets (695cf00)
• IE8 compatibility (e9898f9)

Reverts

• Revert "test: remove travis cache, may be buggy" (415dab6)

2.1.2 (2015-06-29)

2.1.1 (2015-06-19)

Bug Fixes

• eslint: Set eslintrc as a valid JSON. (7bab8aa)

2.1.0 (2015-06-15)

2.0.4 (2015-05-19)

2.0.3 (2015-05-13)

2.0.2 (2015-05-06)

2.0.1 (2015-04-28)

2.0.0 (2015-04-28)

2.0.0-rc5 (2015-04-21)

2.0.0-beta (2015-04-16)

1.0.0 (2015-03-24)