chore: generated code for commit 23a72c39. [skip ci]

algolia/api-clients-automation@23a72c3

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>

Author: algolia-bot

packages/algoliasearch/lite/model/highlightResult.ts

@@ -1,20 +1,3 @@
-import type { MatchLevel } from './matchLevel';
+import type { HighlightResultOption } from './highlightResultOption';
 
-/**
- * Highlighted attributes.
- */
-export type HighlightResult = {
-  /**
-   * Markup text with occurrences highlighted.
-   */
-  value?: string;
-  matchLevel?: MatchLevel;
-  /**
-   * List of words from the query that matched the object.
-   */
-  matchedWords?: string[];
-  /**
-   * Whether the entire attribute value is highlighted.
-   */
-  fullyHighlighted?: boolean;
-};
+export type HighlightResult = HighlightResultOption | HighlightResultOption[];

packages/algoliasearch/lite/model/highlightResultOption.ts

@@ -0,0 +1,20 @@
+import type { MatchLevel } from './matchLevel';
+
+/**
+ * Show highlighted section and words matched on a query.
+ */
+export type HighlightResultOption = {
+  /**
+   * Markup text with occurrences highlighted.
+   */
+  value: string;
+  matchLevel: MatchLevel;
+  /**
+   * List of words from the query that matched the object.
+   */
+  matchedWords: string[];
+  /**
+   * Whether the entire attribute value is highlighted.
+   */
+  fullyHighlighted?: boolean;
+};

packages/algoliasearch/lite/model/hit.ts

@@ -10,8 +10,14 @@ export type Hit = Record<string, any> & {
    * Unique identifier of the object.
    */
   objectID: string;
-  _highlightResult?: HighlightResult;
-  _snippetResult?: SnippetResult;
+  /**
+   * Show highlighted section and words matched on a query.
+   */
+  _highlightResult?: Record<string, HighlightResult>;
+  /**
+   * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+   */
+  _snippetResult?: Record<string, SnippetResult>;
   _rankingInfo?: RankingInfo;
   _distinctSeqID?: number;
 };

packages/algoliasearch/lite/model/index.ts

@@ -40,6 +40,7 @@ export * from './facets';
 export * from './facetsStats';
 export * from './fetchedIndex';
 export * from './highlightResult';
+export * from './highlightResultOption';
 export * from './hit';
 export * from './ignorePlurals';
 export * from './indexSettings';
@@ -85,6 +86,7 @@ export * from './searchSynonymsResponse';
 export * from './searchTypeDefault';
 export * from './searchTypeFacet';
 export * from './snippetResult';
+export * from './snippetResultOption';
 export * from './sortRemainingBy';
 export * from './source';
 export * from './standardEntries';

packages/algoliasearch/lite/model/snippetResult.ts

@@ -1,9 +1,3 @@
-import type { MatchLevel } from './matchLevel';
+import type { SnippetResultOption } from './snippetResultOption';
 
-export type SnippetResult = {
-  /**
-   * Markup text with occurrences highlighted.
-   */
-  value?: string;
-  matchLevel?: MatchLevel;
-};
+export type SnippetResult = SnippetResultOption | SnippetResultOption[];

packages/algoliasearch/lite/model/snippetResultOption.ts

@@ -0,0 +1,12 @@
+import type { MatchLevel } from './matchLevel';
+
+/**
+ * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+ */
+export type SnippetResultOption = {
+  /**
+   * Markup text with occurrences highlighted.
+   */
+  value: string;
+  matchLevel: MatchLevel;
+};

packages/algoliasearch/lite/model/synonymHitHighlightResult.ts

@@ -4,6 +4,9 @@ import type { HighlightResult } from './highlightResult';
  * Highlighted results.
  */
 export type SynonymHitHighlightResult = {
-  type?: HighlightResult;
-  synonyms?: HighlightResult[];
+  /**
+   * Show highlighted section and words matched on a query.
+   */
+  type?: Record<string, HighlightResult>;
+  synonyms?: Array<Record<string, HighlightResult>>;
 };

packages/client-search/model/highlightResult.ts

@@ -1,20 +1,3 @@
-import type { MatchLevel } from './matchLevel';
+import type { HighlightResultOption } from './highlightResultOption';
 
-/**
- * Highlighted attributes.
- */
-export type HighlightResult = {
-  /**
-   * Markup text with occurrences highlighted.
-   */
-  value?: string;
-  matchLevel?: MatchLevel;
-  /**
-   * List of words from the query that matched the object.
-   */
-  matchedWords?: string[];
-  /**
-   * Whether the entire attribute value is highlighted.
-   */
-  fullyHighlighted?: boolean;
-};
+export type HighlightResult = HighlightResultOption | HighlightResultOption[];

packages/client-search/model/highlightResultOption.ts

@@ -0,0 +1,20 @@
+import type { MatchLevel } from './matchLevel';
+
+/**
+ * Show highlighted section and words matched on a query.
+ */
+export type HighlightResultOption = {
+  /**
+   * Markup text with occurrences highlighted.
+   */
+  value: string;
+  matchLevel: MatchLevel;
+  /**
+   * List of words from the query that matched the object.
+   */
+  matchedWords: string[];
+  /**
+   * Whether the entire attribute value is highlighted.
+   */
+  fullyHighlighted?: boolean;
+};

packages/client-search/model/hit.ts

@@ -10,8 +10,14 @@ export type Hit = Record<string, any> & {
    * Unique identifier of the object.
    */
   objectID: string;
-  _highlightResult?: HighlightResult;
-  _snippetResult?: SnippetResult;
+  /**
+   * Show highlighted section and words matched on a query.
+   */
+  _highlightResult?: Record<string, HighlightResult>;
+  /**
+   * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+   */
+  _snippetResult?: Record<string, SnippetResult>;
   _rankingInfo?: RankingInfo;
   _distinctSeqID?: number;
 };

packages/client-search/model/index.ts

@@ -62,6 +62,7 @@ export * from './getTaskResponse';
 export * from './getTopUserIdsResponse';
 export * from './hasPendingMappingsResponse';
 export * from './highlightResult';
+export * from './highlightResultOption';
 export * from './hit';
 export * from './ignorePlurals';
 export * from './indexSettings';
@@ -127,6 +128,7 @@ export * from './searchTypeFacet';
 export * from './searchUserIdsParams';
 export * from './searchUserIdsResponse';
 export * from './snippetResult';
+export * from './snippetResultOption';
 export * from './sortRemainingBy';
 export * from './source';
 export * from './standardEntries';

packages/client-search/model/snippetResult.ts

@@ -1,9 +1,3 @@
-import type { MatchLevel } from './matchLevel';
+import type { SnippetResultOption } from './snippetResultOption';
 
-export type SnippetResult = {
-  /**
-   * Markup text with occurrences highlighted.
-   */
-  value?: string;
-  matchLevel?: MatchLevel;
-};
+export type SnippetResult = SnippetResultOption | SnippetResultOption[];

packages/client-search/model/snippetResultOption.ts

@@ -0,0 +1,12 @@
+import type { MatchLevel } from './matchLevel';
+
+/**
+ * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+ */
+export type SnippetResultOption = {
+  /**
+   * Markup text with occurrences highlighted.
+   */
+  value: string;
+  matchLevel: MatchLevel;
+};

packages/client-search/model/synonymHitHighlightResult.ts

@@ -4,6 +4,9 @@ import type { HighlightResult } from './highlightResult';
  * Highlighted results.
  */
 export type SynonymHitHighlightResult = {
-  type?: HighlightResult;
-  synonyms?: HighlightResult[];
+  /**
+   * Show highlighted section and words matched on a query.
+   */
+  type?: Record<string, HighlightResult>;
+  synonyms?: Array<Record<string, HighlightResult>>;
 };

packages/client-search/model/userHighlightResult.ts

@@ -1,6 +1,12 @@
 import type { HighlightResult } from './highlightResult';
 
 export type UserHighlightResult = {
-  userID: HighlightResult;
-  clusterName: HighlightResult;
+  /**
+   * Show highlighted section and words matched on a query.
+   */
+  userID: Record<string, HighlightResult>;
+  /**
+   * Show highlighted section and words matched on a query.
+   */
+  clusterName: Record<string, HighlightResult>;
 };

packages/recommend/model/highlightResult.ts

@@ -1,20 +1,3 @@
-import type { MatchLevel } from './matchLevel';
+import type { HighlightResultOption } from './highlightResultOption';
 
-/**
- * Highlighted attributes.
- */
-export type HighlightResult = {
-  /**
-   * Markup text with occurrences highlighted.
-   */
-  value?: string;
-  matchLevel?: MatchLevel;
-  /**
-   * List of words from the query that matched the object.
-   */
-  matchedWords?: string[];
-  /**
-   * Whether the entire attribute value is highlighted.
-   */
-  fullyHighlighted?: boolean;
-};
+export type HighlightResult = HighlightResultOption | HighlightResultOption[];

packages/recommend/model/highlightResultOption.ts

@@ -0,0 +1,20 @@
+import type { MatchLevel } from './matchLevel';
+
+/**
+ * Show highlighted section and words matched on a query.
+ */
+export type HighlightResultOption = {
+  /**
+   * Markup text with occurrences highlighted.
+   */
+  value: string;
+  matchLevel: MatchLevel;
+  /**
+   * List of words from the query that matched the object.
+   */
+  matchedWords: string[];
+  /**
+   * Whether the entire attribute value is highlighted.
+   */
+  fullyHighlighted?: boolean;
+};

packages/recommend/model/index.ts

@@ -17,6 +17,7 @@ export * from './facetsStats';
 export * from './getRecommendationsParams';
 export * from './getRecommendationsResponse';
 export * from './highlightResult';
+export * from './highlightResultOption';
 export * from './ignorePlurals';
 export * from './indexSettingsAsSearchParams';
 export * from './matchLevel';
@@ -40,6 +41,7 @@ export * from './renderingContent';
 export * from './searchParamsObject';
 export * from './searchParamsQuery';
 export * from './snippetResult';
+export * from './snippetResultOption';
 export * from './sortRemainingBy';
 export * from './tagFilters';
 export * from './trendingModels';

packages/recommend/model/recommendHit.ts

@@ -10,8 +10,14 @@ export type RecommendHit = Record<string, any> & {
    * Unique identifier of the object.
    */
   objectID: string;
-  _highlightResult?: HighlightResult;
-  _snippetResult?: SnippetResult;
+  /**
+   * Show highlighted section and words matched on a query.
+   */
+  _highlightResult?: Record<string, HighlightResult>;
+  /**
+   * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+   */
+  _snippetResult?: Record<string, SnippetResult>;
   _rankingInfo?: RankingInfo;
   _distinctSeqID?: number;
   /**

packages/recommend/model/snippetResult.ts

@@ -1,9 +1,3 @@
-import type { MatchLevel } from './matchLevel';
+import type { SnippetResultOption } from './snippetResultOption';
 
-export type SnippetResult = {
-  /**
-   * Markup text with occurrences highlighted.
-   */
-  value?: string;
-  matchLevel?: MatchLevel;
-};
+export type SnippetResult = SnippetResultOption | SnippetResultOption[];

packages/recommend/model/snippetResultOption.ts

@@ -0,0 +1,12 @@
+import type { MatchLevel } from './matchLevel';
+
+/**
+ * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+ */
+export type SnippetResultOption = {
+  /**
+   * Markup text with occurrences highlighted.
+   */
+  value: string;
+  matchLevel: MatchLevel;
+};