feat(types): introduce generic Hit type (#1191)

Author: francoischalifour

packages/client-search/src/types/Hit.ts

@@ -0,0 +1,47 @@
+type HighlightMatch = {
+  readonly value: string;
+  readonly matchLevel: 'none' | 'partial' | 'full';
+  readonly matchedWords: readonly string[];
+  readonly fullyHighlighted?: boolean;
+};
+
+export type HighlightResult<THit> = THit extends string | number
+  ? HighlightMatch
+  : {
+      [KAttribute in keyof THit]: HighlightResult<THit[KAttribute]>;
+    };
+
+type SnippetMatch = {
+  readonly value: string;
+  readonly matchLevel: 'none' | 'partial' | 'full';
+};
+
+export type SnippetResult<THit> = THit extends string | number
+  ? SnippetMatch
+  : {
+      [KAttribute in keyof THit]: SnippetResult<THit[KAttribute]>;
+    };
+
+export 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;
+};

packages/client-search/src/types/MultipleQueriesResponse.ts

@@ -1,8 +1,8 @@
-import { ObjectWithObjectID, SearchResponse } from '.';
+import { SearchResponse } from '.';
 
 export type MultipleQueriesResponse<TObject> = {
   /**
    * The list of results.
    */
-  results: Array<SearchResponse<TObject & ObjectWithObjectID>>;
+  results: Array<SearchResponse<TObject>>;
 };

packages/client-search/src/types/SearchResponse.ts

@@ -1,12 +1,12 @@
-import { ObjectWithObjectID } from '.';
+import { Hit } from '.';
 
 export type SearchResponse<TObject = {}> = {
   /**
    * The hits returned by the search.
    *
    * 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).

packages/client-search/src/types/index.ts

@@ -36,6 +36,7 @@ export * from './GetObjectsResponse';
 export * from './GetTopUserIDsResponse';
 export * from './HasPendingMappingsOptions';
 export * from './HasPendingMappingsResponse';
+export * from './Hit';
 export * from './IndexOperationResponse';
 export * from './Indice';
 export * from './ListApiKeysResponse';