@algolia/client-search 4.11.0 → 4.12.2

package/dist/client-search.cjs.js

@@ -278,6 +278,15 @@ const getApiKey = (base) => {
     };
 };
 
+const getAppTask = (base) => {
+    return (taskID, requestOptions) => {
+        return base.transporter.read({
+            method: requesterCommon.MethodEnum.Get,
+            path: clientCommon.encode('1/task/%s', taskID.toString()),
+        }, requestOptions);
+    };
+};
+
 const getDictionarySettings = (base) => {
     return (requestOptions) => {
         return base.transporter.read({
@@ -317,15 +326,6 @@ const getTopUserIDs = (base) => {
     };
 };
 
-const getAppTask = (base) => {
-    return (taskID, requestOptions) => {
-        return base.transporter.read({
-            method: requesterCommon.MethodEnum.Get,
-            path: clientCommon.encode('1/task/%s', taskID.toString()),
-        }, requestOptions);
-    };
-};
-
 const getUserID = (base) => {
     return (userID, requestOptions) => {
         return base.transporter.read({

package/dist/client-search.d.ts

@@ -389,17 +389,17 @@ export declare type DeleteByFiltersOptions = {
     /**
      *  Filter hits by facet value.
      */
-    readonly facetFilters?: string | readonly string[] | ReadonlyArray<readonly string[]>;
+    readonly facetFilters?: string | readonly string[] | ReadonlyArray<readonly string[] | string>;
     /**
      * Filter on numeric attributes.
      */
-    readonly numericFilters?: string | readonly string[] | ReadonlyArray<readonly string[]>;
+    readonly numericFilters?: string | readonly string[] | ReadonlyArray<readonly string[] | string>;
     /**
      * Filter hits by tags. tagFilters is a different way of filtering, which relies on the _tags
      * attribute. It uses a simpler syntax than filters. You can use it when you want to do
      * simple filtering based on tags.
      */
-    readonly tagFilters?: string | readonly string[] | ReadonlyArray<readonly string[]>;
+    readonly tagFilters?: string | readonly string[] | ReadonlyArray<readonly string[] | string>;
     /**
      * Search for entries around a central geolocation, enabling a geo search within a circular area.
      */
@@ -1099,6 +1099,7 @@ export declare type RankingInfo = {
         readonly rankingScore: number;
         readonly score: number;
     };
+    readonly promotedByReRanking?: boolean;
 };
 
 export declare const removeUserID: (base: SearchClient) => (userID: string, requestOptions?: RequestOptions | undefined) => Readonly<Promise<RemoveUserIDResponse>>;
@@ -1127,7 +1128,7 @@ export declare const replaceAllSynonyms: (base: SearchIndex) => (synonyms: reado
 
 export declare const replaceDictionaryEntries: (base: SearchClient) => (dictionary: DictionaryName, entries: readonly DictionaryEntry[], requestOptions?: (RequestOptions & DictionaryEntriesOptions) | undefined) => Readonly<WaitablePromise<DictionaryEntriesResponse>>;
 
-declare type RequireAtLeastOne<TType> = {
+export declare type RequireAtLeastOne<TType> = {
     [TKey in keyof TType]-?: Required<Pick<TType, TKey>> & Partial<Pick<TType, Exclude<keyof TType, TKey>>>;
 }[keyof TType];
 
@@ -1399,7 +1400,7 @@ export declare type SearchOptions = {
     /**
      *  Filter hits by facet value.
      */
-    readonly facetFilters?: string | readonly string[] | ReadonlyArray<readonly string[]>;
+    readonly facetFilters?: string | readonly string[] | ReadonlyArray<readonly string[] | string>;
     /**
      * Create filters for ranking purposes, where records that match the filter are ranked highest.
      */
@@ -1407,13 +1408,13 @@ export declare type SearchOptions = {
     /**
      * Filter on numeric attributes.
      */
-    readonly numericFilters?: string | readonly string[] | ReadonlyArray<readonly string[]>;
+    readonly numericFilters?: string | readonly string[] | ReadonlyArray<readonly string[] | string>;
     /**
      * Filter hits by tags. tagFilters is a different way of filtering, which relies on the _tags
      * attribute. It uses a simpler syntax than filters. You can use it when you want to do
      * simple filtering based on tags.
      */
-    readonly tagFilters?: string | readonly string[] | ReadonlyArray<readonly string[]>;
+    readonly tagFilters?: string | readonly string[] | ReadonlyArray<readonly string[] | string>;
     /**
      * Determines how to calculate the total score for filtering.
      */
@@ -1679,6 +1680,10 @@ export declare type SearchOptions = {
      * This parameter is only used to turn off Dynamic Re-Ranking (with false) at search time.
      */
     readonly enableReRanking?: boolean;
+    /**
+     * When Dynamic Re-Ranking is enabled, only records that match these filters will be impacted by Dynamic Re-Ranking.
+     */
+    readonly reRankingApplyFilter?: string | readonly string[] | ReadonlyArray<readonly string[] | string> | null;
 };
 
 export declare type SearchResponse<TObject = {}> = {
@@ -2292,6 +2297,18 @@ export declare type Settings = {
             };
         };
     };
+    /**
+     * Whether this index should use Dynamic Re-Ranking.
+     * @link https://www.algolia.com/doc/guides/algolia-ai/re-ranking/
+     *
+     * Note: You need to turn on Dynamic Re-Ranking on your index for it to have an effect on
+     * your search results. You can do this through the Re-Ranking page on the dashboard.
+     */
+    readonly enableReRanking?: boolean;
+    /**
+     * When Dynamic Re-Ranking is enabled, only records that match these filters will be impacted by Dynamic Re-Ranking.
+     */
+    readonly reRankingApplyFilter?: string | readonly string[] | ReadonlyArray<readonly string[] | string> | null;
 };
 
 declare type SharedMultipleQueriesQuery = {

package/dist/client-search.esm.js

@@ -274,6 +274,15 @@ const getApiKey = (base) => {
     };
 };
 
+const getAppTask = (base) => {
+    return (taskID, requestOptions) => {
+        return base.transporter.read({
+            method: MethodEnum.Get,
+            path: encode('1/task/%s', taskID.toString()),
+        }, requestOptions);
+    };
+};
+
 const getDictionarySettings = (base) => {
     return (requestOptions) => {
         return base.transporter.read({
@@ -313,15 +322,6 @@ const getTopUserIDs = (base) => {
     };
 };
 
-const getAppTask = (base) => {
-    return (taskID, requestOptions) => {
-        return base.transporter.read({
-            method: MethodEnum.Get,
-            path: encode('1/task/%s', taskID.toString()),
-        }, requestOptions);
-    };
-};
-
 const getUserID = (base) => {
     return (userID, requestOptions) => {
         return base.transporter.read({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/client-search",
-  "version": "4.11.0",
+  "version": "4.12.2",
   "private": false,
   "repository": {
     "type": "git",
@@ -16,8 +16,8 @@
     "dist"
   ],
   "dependencies": {
-    "@algolia/client-common": "4.11.0",
-    "@algolia/requester-common": "4.11.0",
-    "@algolia/transporter": "4.11.0"
+    "@algolia/client-common": "4.12.2",
+    "@algolia/requester-common": "4.12.2",
+    "@algolia/transporter": "4.12.2"
   }
 }