Skip to content

Commit 50b78a3

Browse files
authored
feat(client-search): add personalization field to RankingInfo (#1213)
* refactor(client-search): extract and expose RankingInfo type * feat(client-search): add personalization field to RankingInfo
1 parent 94bfb75 commit 50b78a3

File tree

1 file changed

+24
-17
lines changed
  • packages/client-search/src/types

1 file changed

+24
-17
lines changed

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

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -22,26 +22,33 @@ export type SnippetResult<THit> = THit extends string | number
2222
[KAttribute in keyof THit]: SnippetResult<THit[KAttribute]>;
2323
};
2424

25+
export type RankingInfo = {
26+
readonly promoted: boolean;
27+
readonly nbTypos: number;
28+
readonly firstMatchedWord: number;
29+
readonly proximityDistance?: number;
30+
readonly geoDistance: number;
31+
readonly geoPrecision?: number;
32+
readonly nbExactWords: number;
33+
readonly words: number;
34+
readonly filters: number;
35+
readonly userScore: number;
36+
readonly matchedGeoLocation?: {
37+
readonly lat: number;
38+
readonly lng: number;
39+
readonly distance: number;
40+
};
41+
readonly personalization?: {
42+
readonly filtersScore: number;
43+
readonly rankingScore: number;
44+
readonly score: number;
45+
};
46+
};
47+
2548
export type Hit<THit> = THit & {
2649
readonly objectID: string;
2750
readonly _highlightResult?: HighlightResult<THit>;
2851
readonly _snippetResult?: SnippetResult<THit>;
29-
readonly _rankingInfo?: {
30-
readonly promoted: boolean;
31-
readonly nbTypos: number;
32-
readonly firstMatchedWord: number;
33-
readonly proximityDistance?: number;
34-
readonly geoDistance: number;
35-
readonly geoPrecision?: number;
36-
readonly nbExactWords: number;
37-
readonly words: number;
38-
readonly filters: number;
39-
readonly userScore: number;
40-
readonly matchedGeoLocation?: {
41-
readonly lat: number;
42-
readonly lng: number;
43-
readonly distance: number;
44-
};
45-
};
52+
readonly _rankingInfo?: RankingInfo;
4653
readonly _distinctSeqID?: number;
4754
};

0 commit comments

Comments
 (0)