refactor(specs): re-organise response for Composition API (generated)

algolia/api-clients-automation#5744

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Clara Muller <5667350+ClaraMuller@users.noreply.github.com>

Author: algolia-bot

packages/composition/model/compositionBaseSearchResponse.ts

@@ -2,6 +2,6 @@
 
 import type { CompositionsSearchResponse } from './compositionsSearchResponse';
 
-export type CompositionBaseSearchResponse = Record<string, any> & {
+export type CompositionBaseSearchResponse = {
   compositions?: CompositionsSearchResponse | undefined;
 };

packages/composition/model/compositionRunAppliedRules.ts

@@ -2,7 +2,7 @@
 
 export type CompositionRunAppliedRules = {
   /**
-   * Unique record identifier.
+   * The objectID of the applied composition rule on this query.
    */
   objectID: string;
 };

packages/composition/model/compositionRunSearchResponse.ts

@@ -4,7 +4,7 @@ import type { CompositionRunAppliedRules } from './compositionRunAppliedRules';
 
 export type CompositionRunSearchResponse = Record<string, any> & {
   /**
-   * Unique record identifier.
+   * The objectID of the composition which generated this result set.
    */
   objectID: string;
 

packages/composition/model/index.ts

@@ -95,12 +95,11 @@ export * from './rulesMultipleBatchResponse';
 export * from './search';
 export * from './searchCompositionRulesParams';
 export * from './searchCompositionRulesResponse';
+export * from './searchFields';
 export * from './searchForFacetValuesParams';
 export * from './searchForFacetValuesRequest';
 export * from './searchForFacetValuesResponse';
 export * from './searchForFacetValuesResults';
-export * from './searchHits';
-export * from './searchPagination';
 export * from './searchResponse';
 export * from './searchResults';
 export * from './searchResultsItem';

packages/composition/model/resultsCompositionsResponse.ts

@@ -2,6 +2,6 @@
 
 import type { ResultsCompositionInfoResponse } from './resultsCompositionInfoResponse';
 
-export type ResultsCompositionsResponse = Record<string, any> & {
+export type ResultsCompositionsResponse = {
   compositions: { [key: string]: ResultsCompositionInfoResponse };
 };

packages/composition/model/resultsInjectedItemAppliedRulesInfoResponse.ts

@@ -2,7 +2,7 @@
 
 export type ResultsInjectedItemAppliedRulesInfoResponse = {
   /**
-   * Unique record identifier.
+   * The objectID of the applied index level rule on this injected group.
    */
   objectID: string;
 };

packages/composition/model/resultsInjectedItemInfoResponse.ts

@@ -3,6 +3,9 @@
 import type { ResultsInjectedItemAppliedRulesInfoResponse } from './resultsInjectedItemAppliedRulesInfoResponse';
 
 export type ResultsInjectedItemInfoResponse = Record<string, any> & {
+  /**
+   * The key of the injected group.
+   */
   key: string;
 
   appliedRules?: Array<ResultsInjectedItemAppliedRulesInfoResponse> | undefined;

packages/composition/model/searchHits.ts …ckages/composition/model/searchFields.tspackages/composition/model/searchHits.ts renamed to packages/composition/model/searchFields.ts packages/composition/model/searchHits.ts renamed to packages/composition/model/searchFields.ts

@@ -2,19 +2,39 @@
 
 import type { Hit } from './hit';
 
-export type SearchHits<T = Record<string, unknown>> = Record<string, any> & {
+export type SearchFields<T = Record<string, unknown>> = {
   /**
    * 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>[];
 
   /**
-   * The search query string.
+   * Number of hits returned per page.
    */
-  query: string;
+  hitsPerPage: number;
+
+  /**
+   * Number of results (hits).
+   */
+  nbHits: number;
+
+  /**
+   * Number of pages of results.
+   */
+  nbPages: number;
+
+  /**
+   * The current page of the results.
+   */
+  page: number;
 
   /**
    * URL-encoded string of all search parameters.
    */
   params: string;
+
+  /**
+   * The search query string.
+   */
+  query: string;
 };

packages/composition/model/searchPagination.ts

@@ -2,10 +2,8 @@
 
 import type { BaseSearchResponse } from './baseSearchResponse';
 import type { ResultsCompositionsResponse } from './resultsCompositionsResponse';
-import type { SearchHits } from './searchHits';
-import type { SearchPagination } from './searchPagination';
+import type { SearchFields } from './searchFields';
 
 export type SearchResultsItem<T = Record<string, unknown>> = BaseSearchResponse &
-  SearchPagination &
-  SearchHits<T> &
+  SearchFields<T> &
   ResultsCompositionsResponse;