@algolia/client-search 5.19.0 → 5.20.1

package/dist/worker.d.ts

@@ -217,14 +217,14 @@ type RedirectURL = {
 };
 
 /**
- * url for a search banner image.
+ * URL for an image to show inside a banner.
  */
 type BannerImageUrl = {
     url?: string;
 };
 
 /**
- * image of a search banner.
+ * Image to show inside a banner.
  */
 type BannerImage = {
     urls?: Array<BannerImageUrl>;
@@ -232,14 +232,14 @@ type BannerImage = {
 };
 
 /**
- * link for a banner defined in merchandising studio.
+ * Link for a banner defined in the Merchandising Studio.
  */
 type BannerLink = {
     url?: string;
 };
 
 /**
- * a search banner with image and url.
+ * Banner with image and link to redirect users.
  */
 type Banner = {
     image?: BannerImage;
@@ -247,11 +247,11 @@ type Banner = {
 };
 
 /**
- * widgets returned from any rules that are applied to the current search.
+ * Widgets returned from any rules that are applied to the current search.
  */
 type Widgets = {
     /**
-     * banners defined in the merchandising studio for the given search.
+     * Banners defined in the Merchandising Studio for a given search.
      */
     banners?: Array<Banner>;
 };
@@ -1056,7 +1056,7 @@ type InsideBoundingBox = string | Array<Array<number>>;
 type NumericFilters = Array<NumericFilters> | string;
 
 /**
- * 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.
+ * 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.
  */
 type OptionalFilters = Array<OptionalFilters> | string;
 
@@ -1253,10 +1253,6 @@ type IndexSettingsAsSearchParams = {
      * 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/).
      */
     ranking?: Array<string>;
-    /**
-     * 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.
-     */
-    customRanking?: Array<string>;
     /**
      * 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.
      */
@@ -1308,10 +1304,6 @@ type IndexSettingsAsSearchParams = {
     disableTypoToleranceOnAttributes?: Array<string>;
     ignorePlurals?: IgnorePlurals;
     removeStopWords?: RemoveStopWords;
-    /**
-     * 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.
-     */
-    keepDiacriticsOnCharacters?: string;
     /**
      * 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/).
      */
@@ -1360,7 +1352,7 @@ type IndexSettingsAsSearchParams = {
      */
     minProximity?: number;
     /**
-     * Properties to include in the API response of `search` and `browse` requests.  By default, all response properties are included. To reduce the response size, you can select, which attributes should be included.  You can\'t exclude these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or any property triggered by the `getRankingInfo` parameter.  Don\'t exclude properties that you might need in your search UI.
+     * Properties to include in the API response of search and browse requests.  By default, all response properties are included. To reduce the response size, you can select which properties should be included.  An empty list may lead to an empty API response (except properties you can\'t exclude).  You can\'t exclude these properties: `message`, `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true.  Your search depends on the `hits` field. If you omit this field, searches won\'t return any results. Your UI might also depend on other properties, for example, for pagination. Before restricting the response size, check the impact on your search experience.
      */
     responseFields?: Array<string>;
     /**
@@ -1501,7 +1493,7 @@ type Consequence = {
     /**
      * A JSON object with custom data that will be appended to the `userData` array in the response. This object isn\'t interpreted by the API and is limited to 1&nbsp;kB of minified JSON.
      */
-    userData?: any | null;
+    userData?: Record<string, unknown>;
 };
 
 type TimeRange = {
@@ -1991,6 +1983,14 @@ type BaseIndexSettings = {
      * 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).
      */
     maxFacetHits?: number;
+    /**
+     * 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.
+     */
+    keepDiacriticsOnCharacters?: string;
+    /**
+     * 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.
+     */
+    customRanking?: Array<string>;
 };
 
 /**
@@ -3025,7 +3025,7 @@ type ReplaceAllObjectsOptions = {
     scopes?: Array<ScopeType>;
 };
 
-declare const apiClientVersion = "5.19.0";
+declare const apiClientVersion = "5.20.1";
 declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.Transporter;
     /**

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "5.19.0",
+  "version": "5.20.1",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/algolia/algoliasearch-client-javascript.git"
@@ -49,18 +49,18 @@
     "index.d.ts"
   ],
   "dependencies": {
-    "@algolia/client-common": "5.19.0",
-    "@algolia/requester-browser-xhr": "5.19.0",
-    "@algolia/requester-fetch": "5.19.0",
-    "@algolia/requester-node-http": "5.19.0"
+    "@algolia/client-common": "5.20.1",
+    "@algolia/requester-browser-xhr": "5.20.1",
+    "@algolia/requester-fetch": "5.20.1",
+    "@algolia/requester-node-http": "5.20.1"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "0.17.2",
-    "@types/node": "22.10.5",
-    "publint": "0.2.12",
-    "rollup": "4.29.1",
-    "tsup": "8.3.5",
-    "typescript": "5.7.2"
+    "@arethetypeswrong/cli": "0.17.3",
+    "@types/node": "22.10.10",
+    "publint": "0.3.2",
+    "rollup": "4.30.1",
+    "tsup": "8.3.6",
+    "typescript": "5.7.3"
   },
   "engines": {
     "node": ">= 14.0.0"