feat(algolia): add getAlgoliaFacetHits preset

[francoischalifour]

Description

The getAlgoliaFacetHits function is an additional search util to our @algolia/autocomplete-preset-algolia package.

We now have:

• getAlgoliaHits
• getAlgoliaResults
• getAlgoliaFacetHits

This function is useful to search for facets in the Autocomplete panel. Later, it will be useful when using Autocomplete Tags to refine the query to a category as a first step of the flow.

Preview

Implementation

The getAlgoliaFacetHits function returns a similar format to React InstantSearch's facet hits from connectRefinementList. This allows to use highlighting utils (e.g., highlightHit) with facet hits.

[
  {
    "count": 507,
    "label": "Mobile phones",
    "_highlightResult": {
      "label": {
        "value": "Mobile <em>phone</em>s"
      }
    }
  },
  {
    "count": 63,
    "label": "Phone cases",
    "_highlightResult": {
      "label": {
        "value": "<em>Phone</em> cases"
      }
    }
  }
]

[francoischalifour]

This any cast is needed for now because our typings require the hit to have objectID. I'll fix that in another PR.

[francoischalifour]

Addressed in #452.

[Haroenv]

this looks great! would love to see what you have in mind for merging requests (not as big of a deal for sffv of course, since that doesn't exist in a single request)

[francoischalifour]

In 8c135a4 I added a test for the JS package.

[francoischalifour]

would love to see what you have in mind for merging requests

I haven't spec-ed it yet but that will be the role of the Requester API. These getAlgolia* functions would be contained in an object that schedules the calls. But this API could be more powerful to handle asynchronous responses (e.g., to support Answers), filtering, etc.