@algolia/client-search 5.19.0 → 5.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (24) hide show
  1. package/README.md +4 -4
  2. package/dist/browser.d.ts +16 -16
  3. package/dist/builds/browser.js +1 -1
  4. package/dist/builds/browser.js.map +1 -1
  5. package/dist/builds/browser.min.js +1 -1
  6. package/dist/builds/browser.min.js.map +1 -1
  7. package/dist/builds/browser.umd.js +1 -1
  8. package/dist/builds/fetch.js +1 -1
  9. package/dist/builds/fetch.js.map +1 -1
  10. package/dist/builds/node.cjs +1 -1
  11. package/dist/builds/node.cjs.map +1 -1
  12. package/dist/builds/node.js +1 -1
  13. package/dist/builds/node.js.map +1 -1
  14. package/dist/builds/worker.js +1 -1
  15. package/dist/builds/worker.js.map +1 -1
  16. package/dist/fetch.d.ts +16 -16
  17. package/dist/node.d.cts +16 -16
  18. package/dist/node.d.ts +16 -16
  19. package/dist/src/searchClient.cjs +1 -1
  20. package/dist/src/searchClient.cjs.map +1 -1
  21. package/dist/src/searchClient.js +1 -1
  22. package/dist/src/searchClient.js.map +1 -1
  23. package/dist/worker.d.ts +16 -16
  24. package/package.json +10 -10
package/README.md CHANGED
@@ -41,11 +41,11 @@ All of our clients comes with type definition, and are available for both browse
41
41
  ### With a package manager
42
42
 
43
43
  ```bash
44
- yarn add @algolia/client-search@5.19.0
44
+ yarn add @algolia/client-search@5.20.0
45
45
  # or
46
- npm install @algolia/client-search@5.19.0
46
+ npm install @algolia/client-search@5.20.0
47
47
  # or
48
- pnpm add @algolia/client-search@5.19.0
48
+ pnpm add @algolia/client-search@5.20.0
49
49
  ```
50
50
 
51
51
  ### Without a package manager
@@ -53,7 +53,7 @@ pnpm add @algolia/client-search@5.19.0
53
53
  Add the following JavaScript snippet to the <head> of your website:
54
54
 
55
55
  ```html
56
- <script src="https://cdn.jsdelivr.net/npm/@algolia/client-search@5.19.0/dist/builds/browser.umd.js"></script>
56
+ <script src="https://cdn.jsdelivr.net/npm/@algolia/client-search@5.20.0/dist/builds/browser.umd.js"></script>
57
57
  ```
58
58
 
59
59
  ### Usage
package/dist/browser.d.ts CHANGED
@@ -217,14 +217,14 @@ type RedirectURL = {
217
217
  };
218
218
 
219
219
  /**
220
- * url for a search banner image.
220
+ * URL for an image to show inside a banner.
221
221
  */
222
222
  type BannerImageUrl = {
223
223
  url?: string;
224
224
  };
225
225
 
226
226
  /**
227
- * image of a search banner.
227
+ * Image to show inside a banner.
228
228
  */
229
229
  type BannerImage = {
230
230
  urls?: Array<BannerImageUrl>;
@@ -232,14 +232,14 @@ type BannerImage = {
232
232
  };
233
233
 
234
234
  /**
235
- * link for a banner defined in merchandising studio.
235
+ * Link for a banner defined in the Merchandising Studio.
236
236
  */
237
237
  type BannerLink = {
238
238
  url?: string;
239
239
  };
240
240
 
241
241
  /**
242
- * a search banner with image and url.
242
+ * Banner with image and link to redirect users.
243
243
  */
244
244
  type Banner = {
245
245
  image?: BannerImage;
@@ -247,11 +247,11 @@ type Banner = {
247
247
  };
248
248
 
249
249
  /**
250
- * widgets returned from any rules that are applied to the current search.
250
+ * Widgets returned from any rules that are applied to the current search.
251
251
  */
252
252
  type Widgets = {
253
253
  /**
254
- * banners defined in the merchandising studio for the given search.
254
+ * Banners defined in the Merchandising Studio for a given search.
255
255
  */
256
256
  banners?: Array<Banner>;
257
257
  };
@@ -1056,7 +1056,7 @@ type InsideBoundingBox = string | Array<Array<number>>;
1056
1056
  type NumericFilters = Array<NumericFilters> | string;
1057
1057
 
1058
1058
  /**
1059
- * Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don\'t exclude records from the search results. Records that match the optional filter rank before records that don\'t match. If you\'re using a negative filter `facet:-value`, matching records rank after records that don\'t match. - Optional filters don\'t work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters don\'t work with numeric attributes.
1059
+ * Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don\'t exclude records from the search results. Records that match the optional filter rank before records that don\'t match. If you\'re using a negative filter `facet:-value`, matching records rank after records that don\'t match. - Optional filters don\'t work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters are applied _before_ custom ranking attributes (in the default [ranking](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/)). - Optional filters don\'t work with numeric attributes.
1060
1060
  */
1061
1061
  type OptionalFilters = Array<OptionalFilters> | string;
1062
1062
 
@@ -1253,10 +1253,6 @@ type IndexSettingsAsSearchParams = {
1253
1253
  * Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/). The tie-breaking algorithm sequentially applies each criterion in the order they\'re specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/), you put the sorting attribute at the top of the list. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting, you should test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).
1254
1254
  */
1255
1255
  ranking?: Array<string>;
1256
- /**
1257
- * Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Attribute names are case-sensitive. The custom ranking attributes decide which items are shown first if the other ranking criteria are equal. Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.
1258
- */
1259
- customRanking?: Array<string>;
1260
1256
  /**
1261
1257
  * Relevancy threshold below which less relevant results aren\'t included in the results. You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.
1262
1258
  */
@@ -1308,10 +1304,6 @@ type IndexSettingsAsSearchParams = {
1308
1304
  disableTypoToleranceOnAttributes?: Array<string>;
1309
1305
  ignorePlurals?: IgnorePlurals;
1310
1306
  removeStopWords?: RemoveStopWords;
1311
- /**
1312
- * Characters for which diacritics should be preserved. By default, Algolia removes diacritics from letters. For example, `é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics.
1313
- */
1314
- keepDiacriticsOnCharacters?: string;
1315
1307
  /**
1316
1308
  * Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries. This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first**. **You should always specify a query language.** If you don\'t specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
1317
1309
  */
@@ -1991,6 +1983,14 @@ type BaseIndexSettings = {
1991
1983
  * Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
1992
1984
  */
1993
1985
  maxFacetHits?: number;
1986
+ /**
1987
+ * Characters for which diacritics should be preserved. By default, Algolia removes diacritics from letters. For example, `é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics.
1988
+ */
1989
+ keepDiacriticsOnCharacters?: string;
1990
+ /**
1991
+ * Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Attribute names are case-sensitive. The custom ranking attributes decide which items are shown first if the other ranking criteria are equal. Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.
1992
+ */
1993
+ customRanking?: Array<string>;
1994
1994
  };
1995
1995
 
1996
1996
  /**
@@ -3025,7 +3025,7 @@ type ReplaceAllObjectsOptions = {
3025
3025
  scopes?: Array<ScopeType>;
3026
3026
  };
3027
3027
 
3028
- declare const apiClientVersion = "5.19.0";
3028
+ declare const apiClientVersion = "5.20.0";
3029
3029
  declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
3030
3030
  transporter: _algolia_client_common.Transporter;
3031
3031
  /**
package/dist/builds/browser.js CHANGED
@@ -16,7 +16,7 @@ import {
16
16
  getAlgoliaAgent,
17
17
  shuffle
18
18
  } from "@algolia/client-common";
19
- var apiClientVersion = "5.19.0";
19
+ var apiClientVersion = "5.20.0";
20
20
  function getDefaultHosts(appId) {
21
21
  return [
22
22
  {