feat(specs): improve Composition Client searchResponse specs (matches…

… SearchClient more closely for IS) (generated) algolia/api-clients-automation#4300 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Emmanuel Krebs <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]>
algolia · Jan 6, 2025 · 0ad2764 · 0ad2764
1 parent aac768e
commit 0ad2764
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 5 deletions.
diff --git a/packages/client-composition/model/searchHits.ts b/packages/client-composition/model/searchHits.ts
@@ -7,4 +7,14 @@ export type SearchHits<T = Record<string, unknown>> = Record<string, any> & {
    * Search results (hits).  Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
    */
   hits: Hit<T>[];
+
+  /**
+   * Search query.
+   */
+  query: string;
+
+  /**
+   * URL-encoded string of all search parameters.
+   */
+  params: string;
 };
diff --git a/packages/client-composition/model/searchPagination.ts b/packages/client-composition/model/searchPagination.ts
@@ -4,20 +4,20 @@ export type SearchPagination = {
   /**
    * Page of search results to retrieve.
    */
-  page?: number;
+  page: number;
 
   /**
    * Number of results (hits).
    */
-  nbHits?: number;
+  nbHits: number;
 
   /**
    * Number of pages of results.
    */
-  nbPages?: number;
+  nbPages: number;
 
   /**
    * Number of hits per page.
    */
-  hitsPerPage?: number;
+  hitsPerPage: number;
 };
diff --git a/packages/client-composition/model/searchResults.ts b/packages/client-composition/model/searchResults.ts
@@ -6,5 +6,5 @@ export type SearchResults<T = Record<string, unknown>> = {
   /**
    * Search results.
    */
-  results?: SearchResultsItem<T>[];
+  results: SearchResultsItem<T>[];
 };