@algolia/client-search 4.3.0 → 4.5.1

package/dist/client-search.d.ts

@@ -288,6 +288,15 @@ export declare type ConsequencePromote = {
      * Promoted rank for the object (zero-based).
      */
     readonly position: number;
+} | {
+    /**
+     * List of unique identifiers for the objects to promote.
+     */
+    readonly objectIDs: readonly string[];
+    /**
+     * Promoted start rank for the objects (zero-based).
+     */
+    readonly position: number;
 };
 
 export declare type ConsequenceQuery = {
@@ -558,7 +567,7 @@ export declare type GetObjectsResponse<TObject> = {
     /**
      * The list of results.
      */
-    results: Array<TObject & ObjectWithObjectID>;
+    results: Array<(TObject & ObjectWithObjectID) | null>;
 };
 
 export declare const getRule: (base: SearchIndex) => (objectID: string, requestOptions?: RequestOptions | undefined) => Readonly<Promise<Rule>>;
@@ -614,6 +623,41 @@ export declare type HasPendingMappingsResponse = {
     };
 };
 
+declare type HighlightMatch = {
+    readonly value: string;
+    readonly matchLevel: 'none' | 'partial' | 'full';
+    readonly matchedWords: readonly string[];
+    readonly fullyHighlighted?: boolean;
+};
+
+export declare type HighlightResult<THit> = THit extends string | number ? HighlightMatch : {
+    [KAttribute in keyof THit]: HighlightResult<THit[KAttribute]>;
+};
+
+export declare type Hit<THit> = THit & {
+    readonly objectID: string;
+    readonly _highlightResult?: HighlightResult<THit>;
+    readonly _snippetResult?: SnippetResult<THit>;
+    readonly _rankingInfo?: {
+        readonly promoted: boolean;
+        readonly nbTypos: number;
+        readonly firstMatchedWord: number;
+        readonly proximityDistance?: number;
+        readonly geoDistance: number;
+        readonly geoPrecision?: number;
+        readonly nbExactWords: number;
+        readonly words: number;
+        readonly filters: number;
+        readonly userScore: number;
+        readonly matchedGeoLocation?: {
+            readonly lat: number;
+            readonly lng: number;
+            readonly distance: number;
+        };
+    };
+    readonly _distinctSeqID?: number;
+};
+
 export declare type IndexOperationResponse = {
     /**
      * The operation task id. May be used to perform a wait task.
@@ -872,7 +916,7 @@ export declare type MultipleQueriesResponse<TObject> = {
     /**
      * The list of results.
      */
-    results: Array<SearchResponse<TObject & ObjectWithObjectID>>;
+    results: Array<SearchResponse<TObject>>;
 };
 
 export declare const multipleSearchForFacetValues: (base: SearchClient) => (queries: readonly {
@@ -949,8 +993,14 @@ export declare type Rule = {
     readonly objectID: string;
     /**
      * Condition of the rule, expressed using the following variables: pattern, anchoring, context.
+     *
+     * @deprecated This parameter is deprecated in favor of `conditions`.
      */
     readonly condition?: Condition;
+    /**
+     * Conditions of the rule, expressed using the following variables: pattern, anchoring, context.
+     */
+    readonly conditions?: readonly Condition[];
     /**
      * Consequence of the rule. At least one of the following object must be used: params, promote, hide, userData.
      */
@@ -1430,7 +1480,7 @@ export declare type SearchResponse<TObject = {}> = {
      *
      * Hits are ordered according to the ranking or sorting of the index being queried.
      */
-    hits: Array<TObject & ObjectWithObjectID>;
+    hits: Array<Hit<TObject>>;
     /**
      * Index of the current page (zero-based).
      */
@@ -1970,6 +2020,15 @@ export declare type Settings = {
     readonly userData?: any;
 };
 
+declare type SnippetMatch = {
+    readonly value: string;
+    readonly matchLevel: 'none' | 'partial' | 'full';
+};
+
+export declare type SnippetResult<THit> = THit extends string | number ? SnippetMatch : {
+    [KAttribute in keyof THit]: SnippetResult<THit[KAttribute]>;
+};
+
 export declare const StrategyEnum: Readonly<Record<string, StrategyType>>;
 
 export declare type StrategyType = 'none' | 'stopIfEnoughMatches';

package/package.json

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