feat(core): introduce Requester API (#540)

Co-authored-by: Sarah Dayan <[email protected]>

Author: francoischalifour

.eslintignore

@@ -4,3 +4,4 @@ build
 coverage
 dist
 node_modules
+.parcel-cache

README.md

@@ -106,7 +106,7 @@ You can find more on the [documentation](https://autocomplete.algolia.com).
 | [`autocomplete-plugin-recent-searches`](packages/autocomplete-plugin-recent-searches) | A plugin to add recent searches to Algolia Autocomplete | [Documentation](https://autocomplete.algolia.com/docs/createLocalStorageRecentSearchesPlugin) |
 | [`autocomplete-plugin-query-suggestions`](packages/autocomplete-plugin-query-suggestions) | A plugin to add query suggestions to Algolia Autocomplete | [Documentation](https://autocomplete.algolia.com/docs/createQuerySuggestionsPlugin) |
 | [`autocomplete-plugin-algolia-insights`](packages/autocomplete-plugin-algolia-insights) | A plugin to add Algolia Insights to Algolia Autocomplete | [Documentation](https://autocomplete.algolia.com/docs/createAlgoliaInsightsPlugin) |
-| [`autocomplete-preset-algolia`](packages/autocomplete-preset-algolia) | Presets to use Algolia features with Autocomplete | [Documentation](https://autocomplete.algolia.com/docs/getAlgoliaHits) |
+| [`autocomplete-preset-algolia`](packages/autocomplete-preset-algolia) | Presets to use Algolia features with Autocomplete | [Documentation](https://autocomplete.algolia.com/docs/getAlgoliaResults) |
 | [`autocomplete-theme-classic`](packages/autocomplete-theme-classic) | Classic theme for Autocomplete | [Documentation](https://autocomplete.algolia.com/docs/autocomplete-theme-classic) |
 
 ## Showcase

bundlesize.config.json

@@ -2,15 +2,15 @@
   "files": [
     {
       "path": "packages/autocomplete-core/dist/umd/index.production.js",
-      "maxSize": "4.75 kB"
+      "maxSize": "5 kB"
     },
     {
       "path": "packages/autocomplete-js/dist/umd/index.production.js",
-      "maxSize": "14.75 kB"
+      "maxSize": "15.25 kB"
     },
     {
       "path": "packages/autocomplete-preset-algolia/dist/umd/index.production.js",
-      "maxSize": "2 kB"
+      "maxSize": "2.25 kB"
     },
     {
       "path": "packages/autocomplete-plugin-algolia-insights/dist/umd/index.production.js",

cypress/test-apps/js/app.tsx

@@ -2,7 +2,7 @@
 import {
   autocomplete,
   AutocompleteComponents,
-  getAlgoliaHits,
+  getAlgoliaResults,
 } from '@algolia/autocomplete-js';
 import {
   AutocompleteInsightsApi,
@@ -78,7 +78,7 @@ autocomplete({
       {
         sourceId: 'products',
         getItems() {
-          return getAlgoliaHits<Product>({
+          return getAlgoliaResults<Product>({
             searchClient,
             queries: [
               {

cypress/test-apps/js/categoriesPlugin.tsx

@@ -1,8 +1,5 @@
 /** @jsx h */
-import {
-  AutocompletePlugin,
-  getAlgoliaFacetHits,
-} from '@algolia/autocomplete-js';
+import { AutocompletePlugin, getAlgoliaFacets } from '@algolia/autocomplete-js';
 import { SearchClient } from 'algoliasearch/lite';
 import { h, Fragment } from 'preact';
 
@@ -24,13 +21,13 @@ export function createCategoriesPlugin({
         {
           sourceId: 'categoriesPlugin',
           getItems() {
-            return getAlgoliaFacetHits({
+            return getAlgoliaFacets({
               searchClient,
               queries: [
                 {
                   indexName: 'instant_search',
+                  facet: 'categories',
                   params: {
-                    facetName: 'categories',
                     facetQuery: query,
                     maxFacetHits: query ? 3 : 10,
                   },

cypress/test-apps/js/package.json

@@ -16,8 +16,8 @@
     "@algolia/autocomplete-plugin-recent-searches": "1.0.0-alpha.44",
     "@algolia/autocomplete-preset-algolia": "1.0.0-alpha.44",
     "@algolia/autocomplete-theme-classic": "1.0.0-alpha.44",
-    "@algolia/client-search": "4.8.6",
-    "algoliasearch": "4.8.6",
+    "@algolia/client-search": "4.9.0",
+    "algoliasearch": "4.9.0",
     "preact": "10.5.13",
     "search-insights": "1.7.1"
   },

examples/multiple-datasets-with-headers/categoriesPlugin.tsx

@@ -1,8 +1,5 @@
 /** @jsx h */
-import {
-  AutocompletePlugin,
-  getAlgoliaFacetHits,
-} from '@algolia/autocomplete-js';
+import { AutocompletePlugin, getAlgoliaFacets } from '@algolia/autocomplete-js';
 import { SearchClient } from 'algoliasearch/lite';
 import { h, Fragment } from 'preact';
 
@@ -24,7 +21,7 @@ export function createCategoriesPlugin({
         {
           sourceId: 'categoriesPlugin',
           getItems() {
-            return getAlgoliaFacetHits({
+            return getAlgoliaFacets({
               searchClient,
               queries: [
                 {

examples/multiple-datasets-with-headers/package.json

@@ -13,7 +13,7 @@
     "@algolia/autocomplete-plugin-query-suggestions": "1.0.0-alpha.45",
     "@algolia/autocomplete-plugin-recent-searches": "1.0.0-alpha.45",
     "@algolia/autocomplete-theme-classic": "1.0.0-alpha.45",
-    "algoliasearch": "4.8.6",
+    "algoliasearch": "4.9.0",
     "preact": "10.5.13"
   },
   "devDependencies": {

examples/playground/app.tsx

@@ -2,7 +2,7 @@
 import {
   autocomplete,
   AutocompleteComponents,
-  getAlgoliaHits,
+  getAlgoliaResults,
 } from '@algolia/autocomplete-js';
 import {
   AutocompleteInsightsApi,
@@ -18,7 +18,7 @@ import '@algolia/autocomplete-theme-classic';
 
 import { createCategoriesPlugin } from './categoriesPlugin';
 import { shortcutsPlugin } from './shortcutsPlugin';
-import { ProductHit } from './types';
+import { ProductRecord, ProductHit } from './types';
 
 const appId = 'latency';
 const apiKey = '6be0576ff61c053d5f9a3225e2a90f76';
@@ -72,7 +72,7 @@ autocomplete<ProductHit>({
       {
         sourceId: 'products',
         getItems() {
-          return getAlgoliaHits<ProductHit>({
+          return getAlgoliaResults<ProductRecord>({
             searchClient,
             queries: [
               {
@@ -85,16 +85,19 @@ autocomplete<ProductHit>({
                 },
               },
             ],
-          }).then(([hits]) => {
-            return hits.map((hit) => ({
-              ...hit,
-              comments: hit.popularity % 100,
-              sale: hit.free_shipping,
-              // eslint-disable-next-line @typescript-eslint/camelcase
-              sale_price: hit.free_shipping
-                ? (hit.price - hit.price / 10).toFixed(2)
-                : hit.price.toString(),
-            }));
+            transformResponse({ hits }) {
+              const [bestBuyHits] = hits;
+
+              return bestBuyHits.map((hit) => ({
+                ...hit,
+                comments: hit.popularity % 100,
+                sale: hit.free_shipping,
+                // eslint-disable-next-line @typescript-eslint/camelcase
+                sale_price: hit.free_shipping
+                  ? (hit.price - hit.price / 10).toFixed(2)
+                  : hit.price.toString(),
+              }));
+            },
           });
         },
         templates: {

examples/playground/categoriesPlugin.tsx

@@ -1,8 +1,5 @@
 /** @jsx h */
-import {
-  AutocompletePlugin,
-  getAlgoliaFacetHits,
-} from '@algolia/autocomplete-js';
+import { AutocompletePlugin, getAlgoliaFacets } from '@algolia/autocomplete-js';
 import { SearchClient } from 'algoliasearch/lite';
 import { h, Fragment } from 'preact';
 
@@ -24,13 +21,13 @@ export function createCategoriesPlugin({
         {
           sourceId: 'categoriesPlugin',
           getItems() {
-            return getAlgoliaFacetHits({
+            return getAlgoliaFacets({
               searchClient,
               queries: [
                 {
                   indexName: 'instant_search',
+                  facet: 'categories',
                   params: {
-                    facetName: 'categories',
                     facetQuery: query,
                     maxFacetHits: query ? 3 : 5,
                   },