@algolia/client-search 5.0.0-alpha.91 → 5.0.0-alpha.98

package/model/clientMethodProps.ts

@@ -25,7 +25,6 @@ import type { SearchRulesParams } from './searchRulesParams';
 import type { SearchSynonymsParams } from './searchSynonymsParams';
 import type { Source } from './source';
 import type { SynonymHit } from './synonymHit';
-import type { SynonymType } from './synonymType';
 
 /**
  * Properties for the `addOrUpdateObject` method.
@@ -101,33 +100,33 @@ export type BrowseProps = {
 };
 
 /**
- * Properties for the `clearAllSynonyms` method.
+ * Properties for the `clearObjects` method.
  */
-export type ClearAllSynonymsProps = {
+export type ClearObjectsProps = {
   /**
    * Index on which to perform the request.
    */
   indexName: string;
-  /**
-   * Indicates whether changed index settings are forwarded to the replica indices.
-   */
-  forwardToReplicas?: boolean;
 };
 
 /**
- * Properties for the `clearObjects` method.
+ * Properties for the `clearRules` method.
  */
-export type ClearObjectsProps = {
+export type ClearRulesProps = {
   /**
    * Index on which to perform the request.
    */
   indexName: string;
+  /**
+   * Indicates whether changed index settings are forwarded to the replica indices.
+   */
+  forwardToReplicas?: boolean;
 };
 
 /**
- * Properties for the `clearRules` method.
+ * Properties for the `clearSynonyms` method.
  */
-export type ClearRulesProps = {
+export type ClearSynonymsProps = {
   /**
    * Index on which to perform the request.
    */
@@ -139,9 +138,23 @@ export type ClearRulesProps = {
 };
 
 /**
- * Properties for the `del` method.
+ * Properties for the `customDelete` method.
+ */
+export type CustomDeleteProps = {
+  /**
+   * Path of the endpoint, anything after \"/1\" must be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to apply to the current query.
+   */
+  parameters?: Record<string, any>;
+};
+
+/**
+ * Properties for the `customGet` method.
  */
-export type DelProps = {
+export type CustomGetProps = {
   /**
    * Path of the endpoint, anything after \"/1\" must be specified.
    */
@@ -152,6 +165,42 @@ export type DelProps = {
   parameters?: Record<string, any>;
 };
 
+/**
+ * Properties for the `customPost` method.
+ */
+export type CustomPostProps = {
+  /**
+   * Path of the endpoint, anything after \"/1\" must be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to apply to the current query.
+   */
+  parameters?: Record<string, any>;
+  /**
+   * Parameters to send with the custom request.
+   */
+  body?: Record<string, any>;
+};
+
+/**
+ * Properties for the `customPut` method.
+ */
+export type CustomPutProps = {
+  /**
+   * Path of the endpoint, anything after \"/1\" must be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to apply to the current query.
+   */
+  parameters?: Record<string, any>;
+  /**
+   * Parameters to send with the custom request.
+   */
+  body?: Record<string, any>;
+};
+
 /**
  * Properties for the `deleteApiKey` method.
  */
@@ -243,20 +292,6 @@ export type DeleteSynonymProps = {
   forwardToReplicas?: boolean;
 };
 
-/**
- * Properties for the `get` method.
- */
-export type GetProps = {
-  /**
-   * Path of the endpoint, anything after \"/1\" must be specified.
-   */
-  path: string;
-  /**
-   * Query parameters to apply to the current query.
-   */
-  parameters?: Record<string, any>;
-};
-
 /**
  * Properties for the `getApiKey` method.
  */
@@ -440,42 +475,6 @@ export type PartialUpdateObjectProps = {
   createIfNotExists?: boolean;
 };
 
-/**
- * Properties for the `post` method.
- */
-export type PostProps = {
-  /**
-   * Path of the endpoint, anything after \"/1\" must be specified.
-   */
-  path: string;
-  /**
-   * Query parameters to apply to the current query.
-   */
-  parameters?: Record<string, any>;
-  /**
-   * Parameters to send with the custom request.
-   */
-  body?: Record<string, any>;
-};
-
-/**
- * Properties for the `put` method.
- */
-export type PutProps = {
-  /**
-   * Path of the endpoint, anything after \"/1\" must be specified.
-   */
-  path: string;
-  /**
-   * Query parameters to apply to the current query.
-   */
-  parameters?: Record<string, any>;
-  /**
-   * Parameters to send with the custom request.
-   */
-  body?: Record<string, any>;
-};
-
 /**
  * Properties for the `removeUserId` method.
  */
@@ -684,18 +683,6 @@ export type SearchSynonymsProps = {
    * Index on which to perform the request.
    */
   indexName: string;
-  /**
-   * Search for specific [types of synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms).
-   */
-  type?: SynonymType;
-  /**
-   * Returns the requested page number (the first page is 0). Page size is set by `hitsPerPage`. When null, there\'s no pagination.
-   */
-  page?: number;
-  /**
-   * Maximum number of hits per page.
-   */
-  hitsPerPage?: number;
   /**
    * Body of the `searchSynonyms` operation.
    */

package/model/highlightResult.ts

@@ -2,4 +2,6 @@
 
 import type { HighlightResultOption } from './highlightResultOption';
 
-export type HighlightResult = HighlightResultOption | HighlightResultOption[];
+export type HighlightResult =
+  | HighlightResultOption
+  | Record<string, HighlightResultOption>;

package/model/searchForFacetValuesResponse.ts

@@ -4,4 +4,14 @@ import type { FacetHits } from './facetHits';
 
 export type SearchForFacetValuesResponse = {
   facetHits: FacetHits[];
+
+  /**
+   * See the `facetsCount` field of the `exhaustive` object in the response.
+   */
+  exhaustiveFacetsCount: boolean;
+
+  /**
+   * Time the server took to process the request, in milliseconds.
+   */
+  processingTimeMS?: number;
 };

package/model/searchResponses.ts

@@ -2,6 +2,6 @@
 
 import type { SearchResult } from './searchResult';
 
-export type SearchResponses = {
-  results: SearchResult[];
+export type SearchResponses<T = Record<string, any>> = {
+  results: Array<SearchResult<T>>;
 };

package/model/searchResult.ts

@@ -3,4 +3,6 @@
 import type { SearchForFacetValuesResponse } from './searchForFacetValuesResponse';
 import type { SearchResponse } from './searchResponse';
 
-export type SearchResult = SearchForFacetValuesResponse | SearchResponse;
+export type SearchResult<T = Record<string, any>> =
+  | SearchForFacetValuesResponse
+  | SearchResponse<T>;

package/model/searchSynonymsParams.ts

@@ -1,8 +1,22 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
+import type { SynonymType } from './synonymType';
+
 export type SearchSynonymsParams = {
   /**
    * Text to search for in an index.
    */
   query?: string;
+
+  type?: SynonymType;
+
+  /**
+   * Page to retrieve (the first page is `0`, not `1`).
+   */
+  page?: number;
+
+  /**
+   * Number of hits per page.
+   */
+  hitsPerPage?: number;
 };

package/model/snippetResult.ts

@@ -2,4 +2,6 @@
 
 import type { SnippetResultOption } from './snippetResultOption';
 
-export type SnippetResult = SnippetResultOption | SnippetResultOption[];
+export type SnippetResult =
+  | Record<string, SnippetResultOption>
+  | SnippetResultOption;

package/model/userHighlightResult.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/client-search",
-  "version": "5.0.0-alpha.91",
+  "version": "5.0.0-alpha.98",
   "description": "JavaScript client for client-search",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
@@ -39,14 +39,14 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.92",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.92",
-    "@algolia/requester-node-http": "5.0.0-alpha.92"
+    "@algolia/client-common": "5.0.0-alpha.99",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.99",
+    "@algolia/requester-node-http": "5.0.0-alpha.99"
   },
   "devDependencies": {
-    "@types/node": "20.9.0",
-    "rollup": "4.3.0",
-    "typescript": "5.2.2"
+    "@types/node": "20.11.5",
+    "rollup": "4.9.5",
+    "typescript": "5.3.3"
   },
   "engines": {
     "node": ">= 14.0.0"