@algolia/client-search 4.10.4 → 4.12.1

package/dist/client-search.cjs.js

@@ -216,6 +216,15 @@ const copySynonyms = (base) => {
     };
 };
 
+const customRequest = (base) => {
+    return (request, requestOptions) => {
+        if (request.method === requesterCommon.MethodEnum.Get) {
+            return base.transporter.read(request, requestOptions);
+        }
+        return base.transporter.write(request, requestOptions);
+    };
+};
+
 const deleteApiKey = (base) => {
     return (apiKey, requestOptions) => {
         const wait = (_, waitRequestOptions) => {
@@ -269,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({
@@ -308,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({
@@ -1294,6 +1303,7 @@ exports.createMissingObjectIDError = createMissingObjectIDError;
 exports.createObjectNotFoundError = createObjectNotFoundError;
 exports.createSearchClient = createSearchClient;
 exports.createValidUntilNotFoundError = createValidUntilNotFoundError;
+exports.customRequest = customRequest;
 exports.deleteApiKey = deleteApiKey;
 exports.deleteBy = deleteBy;
 exports.deleteDictionaryEntries = deleteDictionaryEntries;

package/dist/client-search.d.ts

@@ -1,6 +1,7 @@
 import { AuthModeType } from '@algolia/client-common';
 import { ClientTransporterOptions } from '@algolia/client-common';
 import { CreateClient } from '@algolia/client-common';
+import { Request } from '@algolia/transporter';
 import { RequestOptions } from '@algolia/transporter';
 import { Transporter } from '@algolia/transporter';
 import { WaitablePromise } from '@algolia/client-common';
@@ -367,6 +368,8 @@ export declare const createSearchClient: CreateClient<SearchClient, SearchClient
 
 export declare function createValidUntilNotFoundError(): Error;
 
+export declare const customRequest: <TResponse = any>(base: SearchClient) => (request: Request, requestOptions?: RequestOptions | undefined) => Readonly<Promise<TResponse>>;
+
 export declare const deleteApiKey: (base: SearchClient) => (apiKey: string, requestOptions?: RequestOptions | undefined) => Readonly<WaitablePromise<DeleteApiKeyResponse>>;
 
 export declare type DeleteApiKeyResponse = {
@@ -386,7 +389,7 @@ 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.
      */
@@ -408,7 +411,7 @@ export declare type DeleteByFiltersOptions = {
     /**
      * Search inside a rectangular area (in geo coordinates).
      */
-    readonly insideBoundingBox?: ReadonlyArray<readonly number[]>;
+    readonly insideBoundingBox?: ReadonlyArray<readonly number[]> | string;
     /**
      * Search inside a polygon (in geo coordinates).
      */
@@ -1124,7 +1127,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];
 
@@ -1396,7 +1399,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.
      */
@@ -1619,7 +1622,7 @@ export declare type SearchOptions = {
     /**
      * Search inside a rectangular area (in geo coordinates).
      */
-    readonly insideBoundingBox?: ReadonlyArray<readonly number[]>;
+    readonly insideBoundingBox?: ReadonlyArray<readonly number[]> | string;
     /**
      * Search inside a polygon (in geo coordinates).
      */
@@ -1667,6 +1670,19 @@ export declare type SearchOptions = {
      * less relevant results.
      */
     readonly relevancyStrictness?: number;
+    /**
+     * Whether this search 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.
+     * 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>;
 };
 
 export declare type SearchResponse<TObject = {}> = {
@@ -2280,6 +2296,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>;
 };
 
 declare type SharedMultipleQueriesQuery = {

package/dist/client-search.esm.js

@@ -212,6 +212,15 @@ const copySynonyms = (base) => {
     };
 };
 
+const customRequest = (base) => {
+    return (request, requestOptions) => {
+        if (request.method === MethodEnum.Get) {
+            return base.transporter.read(request, requestOptions);
+        }
+        return base.transporter.write(request, requestOptions);
+    };
+};
+
 const deleteApiKey = (base) => {
     return (apiKey, requestOptions) => {
         const wait = (_, waitRequestOptions) => {
@@ -265,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({
@@ -304,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({
@@ -1264,4 +1273,4 @@ const SynonymEnum = {
     Placeholder: 'placeholder',
 };
 
-export { ApiKeyACLEnum, BatchActionEnum, ScopeEnum, StrategyEnum, SynonymEnum, addApiKey, assignUserID, assignUserIDs, batch, browseObjects, browseRules, browseSynonyms, chunkedBatch, clearDictionaryEntries, clearObjects, clearRules, clearSynonyms, copyIndex, copyRules, copySettings, copySynonyms, createBrowsablePromise, createMissingObjectIDError, createObjectNotFoundError, createSearchClient, createValidUntilNotFoundError, deleteApiKey, deleteBy, deleteDictionaryEntries, deleteIndex, deleteObject, deleteObjects, deleteRule, deleteSynonym, exists, findAnswers, findObject, generateSecuredApiKey, getApiKey, getAppTask, getDictionarySettings, getLogs, getObject, getObjectPosition, getObjects, getRule, getSecuredApiKeyRemainingValidity, getSettings, getSynonym, getTask, getTopUserIDs, getUserID, hasPendingMappings, initIndex, listApiKeys, listClusters, listIndices, listUserIDs, moveIndex, multipleBatch, multipleGetObjects, multipleQueries, multipleSearchForFacetValues, partialUpdateObject, partialUpdateObjects, removeUserID, replaceAllObjects, replaceAllRules, replaceAllSynonyms, replaceDictionaryEntries, restoreApiKey, saveDictionaryEntries, saveObject, saveObjects, saveRule, saveRules, saveSynonym, saveSynonyms, search, searchDictionaryEntries, searchForFacetValues, searchRules, searchSynonyms, searchUserIDs, setDictionarySettings, setSettings, updateApiKey, waitAppTask, waitTask };
+export { ApiKeyACLEnum, BatchActionEnum, ScopeEnum, StrategyEnum, SynonymEnum, addApiKey, assignUserID, assignUserIDs, batch, browseObjects, browseRules, browseSynonyms, chunkedBatch, clearDictionaryEntries, clearObjects, clearRules, clearSynonyms, copyIndex, copyRules, copySettings, copySynonyms, createBrowsablePromise, createMissingObjectIDError, createObjectNotFoundError, createSearchClient, createValidUntilNotFoundError, customRequest, deleteApiKey, deleteBy, deleteDictionaryEntries, deleteIndex, deleteObject, deleteObjects, deleteRule, deleteSynonym, exists, findAnswers, findObject, generateSecuredApiKey, getApiKey, getAppTask, getDictionarySettings, getLogs, getObject, getObjectPosition, getObjects, getRule, getSecuredApiKeyRemainingValidity, getSettings, getSynonym, getTask, getTopUserIDs, getUserID, hasPendingMappings, initIndex, listApiKeys, listClusters, listIndices, listUserIDs, moveIndex, multipleBatch, multipleGetObjects, multipleQueries, multipleSearchForFacetValues, partialUpdateObject, partialUpdateObjects, removeUserID, replaceAllObjects, replaceAllRules, replaceAllSynonyms, replaceDictionaryEntries, restoreApiKey, saveDictionaryEntries, saveObject, saveObjects, saveRule, saveRules, saveSynonym, saveSynonyms, search, searchDictionaryEntries, searchForFacetValues, searchRules, searchSynonyms, searchUserIDs, setDictionarySettings, setSettings, updateApiKey, waitAppTask, waitTask };

package/package.json

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