algoliasearch 5.0.0-alpha.90 → 5.0.0-alpha.97

package/lite/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/lite/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/lite/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/lite/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/lite/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/lite/src/liteClient.ts

@@ -16,13 +16,13 @@ import type {
 } from '@algolia/client-common';
 
 import type {
-  PostProps,
+  CustomPostProps,
   LegacySearchMethodProps,
 } from '../model/clientMethodProps';
 import type { SearchMethodParams } from '../model/searchMethodParams';
 import type { SearchResponses } from '../model/searchResponses';
 
-export const apiClientVersion = '5.0.0-alpha.90';
+export const apiClientVersion = '5.0.0-alpha.97';
 
 function getDefaultHosts(appId: string): Host[] {
   return (
@@ -126,18 +126,20 @@ export function createLiteClient({
      * This method allow you to send requests to the Algolia REST API.
      *
      * @summary Send requests to the Algolia REST API.
-     * @param post - The post object.
-     * @param post.path - Path of the endpoint, anything after \"/1\" must be specified.
-     * @param post.parameters - Query parameters to apply to the current query.
-     * @param post.body - Parameters to send with the custom request.
+     * @param customPost - The customPost object.
+     * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customPost.parameters - Query parameters to apply to the current query.
+     * @param customPost.body - Parameters to send with the custom request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    post(
-      { path, parameters, body }: PostProps,
+    customPost(
+      { path, parameters, body }: CustomPostProps,
       requestOptions?: RequestOptions
     ): Promise<Record<string, any>> {
       if (!path) {
-        throw new Error('Parameter `path` is required when calling `post`.');
+        throw new Error(
+          'Parameter `path` is required when calling `customPost`.'
+        );
       }
 
       const requestPath = '/1{path}'.replace('{path}', path);
@@ -162,10 +164,10 @@ export function createLiteClient({
      * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    search(
+    search<T>(
       searchMethodParams: LegacySearchMethodProps | SearchMethodParams,
       requestOptions?: RequestOptions
-    ): Promise<SearchResponses> {
+    ): Promise<SearchResponses<T>> {
       if (searchMethodParams && Array.isArray(searchMethodParams)) {
         const newSignatureRequest: SearchMethodParams = {
           requests: searchMethodParams.map(({ params, ...legacyRequest }) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "algoliasearch",
-  "version": "5.0.0-alpha.90",
+  "version": "5.0.0-alpha.97",
   "description": "A fully-featured and blazing-fast JavaScript API client to interact with Algolia API.",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
@@ -60,22 +60,22 @@
     "test": "jest"
   },
   "dependencies": {
-    "@algolia/client-abtesting": "5.0.0-alpha.90",
-    "@algolia/client-analytics": "5.0.0-alpha.90",
-    "@algolia/client-common": "5.0.0-alpha.91",
-    "@algolia/client-personalization": "5.0.0-alpha.90",
-    "@algolia/client-search": "5.0.0-alpha.90",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.91",
-    "@algolia/requester-node-http": "5.0.0-alpha.91"
+    "@algolia/client-abtesting": "5.0.0-alpha.97",
+    "@algolia/client-analytics": "5.0.0-alpha.97",
+    "@algolia/client-common": "5.0.0-alpha.98",
+    "@algolia/client-personalization": "5.0.0-alpha.97",
+    "@algolia/client-search": "5.0.0-alpha.97",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.98",
+    "@algolia/requester-node-http": "5.0.0-alpha.98"
   },
   "devDependencies": {
-    "@babel/preset-env": "7.23.2",
-    "@babel/preset-typescript": "7.23.2",
-    "@types/jest": "29.5.7",
-    "@types/node": "20.8.10",
+    "@babel/preset-env": "7.23.8",
+    "@babel/preset-typescript": "7.23.3",
+    "@types/jest": "29.5.11",
+    "@types/node": "20.11.1",
     "jest": "29.7.0",
-    "rollup": "4.3.0",
-    "typescript": "5.2.2"
+    "rollup": "4.9.5",
+    "typescript": "5.3.3"
   },
   "engines": {
     "node": ">= 14.0.0"