algoliasearch 5.0.0-alpha.99 → 5.0.0-beta.1

package/lite/src/liteClient.ts

@@ -10,9 +10,9 @@ import type {
   CreateClientOptions,
   Headers,
   Host,
+  QueryParameters,
   Request,
   RequestOptions,
-  QueryParameters,
 } from '@algolia/client-common';
 
 import type {
@@ -22,7 +22,7 @@ import type {
 import type { SearchMethodParams } from '../model/searchMethodParams';
 import type { SearchResponses } from '../model/searchResponses';
 
-export const apiClientVersion = '5.0.0-alpha.99';
+export const apiClientVersion = '5.0.0-beta.1';
 
 function getDefaultHosts(appId: string): Host[] {
   return (
@@ -125,7 +125,6 @@ export function createLiteClient({
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @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.
@@ -142,7 +141,7 @@ export function createLiteClient({
         );
       }
 
-      const requestPath = '/1{path}'.replace('{path}', path);
+      const requestPath = '/{path}'.replace('{path}', path);
       const headers: Headers = {};
       const queryParameters: QueryParameters = parameters ? parameters : {};
 
@@ -158,10 +157,12 @@ export function createLiteClient({
     },
 
     /**
-     * Send multiple search queries to one or more indices.
+     * Sends multiple search request to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.
      *
-     * @summary Search multiple indices.
-     * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
+     * Required API Key ACLs:
+     * - search.
+     *
+     * @param searchMethodParams - Muli-search request body. Results are returned in the same order as the requests.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     search<T>(
@@ -223,8 +224,3 @@ export function createLiteClient({
     },
   };
 }
-
-/**
- * The client type.
- */
-export type LiteClient = ReturnType<typeof createLiteClient>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "algoliasearch",
-  "version": "5.0.0-alpha.99",
+  "version": "5.0.0-beta.1",
   "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.99",
-    "@algolia/client-analytics": "5.0.0-alpha.99",
-    "@algolia/client-common": "5.0.0-alpha.100",
-    "@algolia/client-personalization": "5.0.0-alpha.99",
-    "@algolia/client-search": "5.0.0-alpha.99",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.100",
-    "@algolia/requester-node-http": "5.0.0-alpha.100"
+    "@algolia/client-abtesting": "5.0.0-beta.1",
+    "@algolia/client-analytics": "5.0.0-beta.1",
+    "@algolia/client-common": "5.0.0-beta.1",
+    "@algolia/client-personalization": "5.0.0-beta.1",
+    "@algolia/client-search": "5.0.0-beta.1",
+    "@algolia/requester-browser-xhr": "5.0.0-beta.1",
+    "@algolia/requester-node-http": "5.0.0-beta.1"
   },
   "devDependencies": {
-    "@babel/preset-env": "7.23.9",
-    "@babel/preset-typescript": "7.23.3",
-    "@types/jest": "29.5.11",
-    "@types/node": "20.11.0",
+    "@babel/preset-env": "7.24.4",
+    "@babel/preset-typescript": "7.24.1",
+    "@types/jest": "29.5.12",
+    "@types/node": "20.12.7",
     "jest": "29.7.0",
-    "rollup": "4.9.6",
-    "typescript": "5.3.3"
+    "rollup": "4.14.2",
+    "typescript": "5.4.5"
   },
   "engines": {
     "node": ">= 14.0.0"

package/dist/client-abtesting/model/currenciesValue.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"currenciesValue.d.ts","sourceRoot":"","sources":["../../../../client-abtesting/model/currenciesValue.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC"}

package/dist/client-analytics/model/averageClickEvent.d.ts

@@ -1,15 +0,0 @@
-export type AverageClickEvent = {
-    /**
-     * Average count of all click events.
-     */
-    average: number;
-    /**
-     * Number of click events.
-     */
-    clickCount: number;
-    /**
-     * Date of the event in the format YYYY-MM-DD.
-     */
-    date: string;
-};
-//# sourceMappingURL=averageClickEvent.d.ts.map

package/dist/client-analytics/model/averageClickEvent.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"averageClickEvent.d.ts","sourceRoot":"","sources":["../../../../client-analytics/model/averageClickEvent.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/client-analytics/model/clickPosition.d.ts

@@ -1,11 +0,0 @@
-export type ClickPosition = {
-    /**
-     * Range of positions with the following pattern: - For positions 1 to 10, the number of click events are shown for each position - For positions 11 to 20, all click events are grouped - For positions 21 and up, all click events are grouped.
-     */
-    position: number[];
-    /**
-     * Number of click events.
-     */
-    clickCount: number;
-};
-//# sourceMappingURL=clickPosition.d.ts.map

package/dist/client-analytics/model/clickPosition.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"clickPosition.d.ts","sourceRoot":"","sources":["../../../../client-analytics/model/clickPosition.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC"}

package/dist/client-analytics/model/clickThroughRateEvent.d.ts

@@ -1,19 +0,0 @@
-export type ClickThroughRateEvent = {
-    /**
-     * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
-     */
-    rate: number;
-    /**
-     * Number of click events.
-     */
-    clickCount: number;
-    /**
-     * Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
-     */
-    trackedSearchCount: number;
-    /**
-     * Date of the event in the format YYYY-MM-DD.
-     */
-    date: string;
-};
-//# sourceMappingURL=clickThroughRateEvent.d.ts.map

package/dist/client-analytics/model/clickThroughRateEvent.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"clickThroughRateEvent.d.ts","sourceRoot":"","sources":["../../../../client-analytics/model/clickThroughRateEvent.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/client-analytics/model/conversionRateEvent.d.ts

@@ -1,19 +0,0 @@
-export type ConversionRateEvent = {
-    /**
-     * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
-     */
-    rate: number;
-    /**
-     * Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
-     */
-    trackedSearchCount: number;
-    /**
-     * Number of converted clicks.
-     */
-    conversionCount: number;
-    /**
-     * Date of the event in the format YYYY-MM-DD.
-     */
-    date: string;
-};
-//# sourceMappingURL=conversionRateEvent.d.ts.map

package/dist/client-analytics/model/conversionRateEvent.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"conversionRateEvent.d.ts","sourceRoot":"","sources":["../../../../client-analytics/model/conversionRateEvent.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/client-analytics/model/getConversationRateResponse.d.ts

@@ -1,20 +0,0 @@
-import type { ConversionRateEvent } from './conversionRateEvent';
-export type GetConversationRateResponse = {
-    /**
-     * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
-     */
-    rate: number;
-    /**
-     * Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
-     */
-    trackedSearchCount: number;
-    /**
-     * Number of converted clicks.
-     */
-    conversionCount: number;
-    /**
-     * Conversion events.
-     */
-    dates: ConversionRateEvent[];
-};
-//# sourceMappingURL=getConversationRateResponse.d.ts.map

package/dist/client-analytics/model/getConversationRateResponse.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"getConversationRateResponse.d.ts","sourceRoot":"","sources":["../../../../client-analytics/model/getConversationRateResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,KAAK,EAAE,mBAAmB,EAAE,CAAC;CAC9B,CAAC"}

package/dist/client-analytics/model/noClickRateEvent.d.ts

@@ -1,19 +0,0 @@
-export type NoClickRateEvent = {
-    /**
-     * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
-     */
-    rate: number;
-    /**
-     * Number of tracked _and_ untracked searches (where the `clickAnalytics` parameter isn\'t `true`).
-     */
-    count: number;
-    /**
-     * Number of click events.
-     */
-    noClickCount: number;
-    /**
-     * Date of the event in the format YYYY-MM-DD.
-     */
-    date: string;
-};
-//# sourceMappingURL=noClickRateEvent.d.ts.map

package/dist/client-analytics/model/noClickRateEvent.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"noClickRateEvent.d.ts","sourceRoot":"","sources":["../../../../client-analytics/model/noClickRateEvent.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/client-analytics/model/noResultsRateEvent.d.ts

@@ -1,19 +0,0 @@
-export type NoResultsRateEvent = {
-    /**
-     * Date of the event in the format YYYY-MM-DD.
-     */
-    date: string;
-    /**
-     * Number of occurences.
-     */
-    noResultCount: number;
-    /**
-     * Number of tracked _and_ untracked searches (where the `clickAnalytics` parameter isn\'t `true`).
-     */
-    count: number;
-    /**
-     * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
-     */
-    rate: number;
-};
-//# sourceMappingURL=noResultsRateEvent.d.ts.map

package/dist/client-analytics/model/noResultsRateEvent.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"noResultsRateEvent.d.ts","sourceRoot":"","sources":["../../../../client-analytics/model/noResultsRateEvent.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/client-analytics/model/searchEvent.d.ts

@@ -1,11 +0,0 @@
-export type SearchEvent = {
-    /**
-     * Date of the event in the format YYYY-MM-DD.
-     */
-    date: string;
-    /**
-     * Number of occurrences.
-     */
-    count: number;
-};
-//# sourceMappingURL=searchEvent.d.ts.map

package/dist/client-analytics/model/searchEvent.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"searchEvent.d.ts","sourceRoot":"","sources":["../../../../client-analytics/model/searchEvent.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}

package/dist/client-analytics/model/searchNoClickEvent.d.ts

@@ -1,15 +0,0 @@
-export type SearchNoClickEvent = {
-    /**
-     * User query.
-     */
-    search: string;
-    /**
-     * Number of occurrences.
-     */
-    count: number;
-    /**
-     * Number of occurrences.
-     */
-    withFilterCount: number;
-};
-//# sourceMappingURL=searchNoClickEvent.d.ts.map

package/dist/client-analytics/model/searchNoClickEvent.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"searchNoClickEvent.d.ts","sourceRoot":"","sources":["../../../../client-analytics/model/searchNoClickEvent.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC"}

package/dist/client-analytics/model/searchNoResultEvent.d.ts

@@ -1,15 +0,0 @@
-export type SearchNoResultEvent = {
-    /**
-     * User query.
-     */
-    search: string;
-    /**
-     * Number of occurrences.
-     */
-    count: number;
-    /**
-     * Number of hits the search query matched.
-     */
-    nbHits: number;
-};
-//# sourceMappingURL=searchNoResultEvent.d.ts.map

package/dist/client-analytics/model/searchNoResultEvent.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"searchNoResultEvent.d.ts","sourceRoot":"","sources":["../../../../client-analytics/model/searchNoResultEvent.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/client-analytics/model/userWithDate.d.ts

@@ -1,11 +0,0 @@
-export type UserWithDate = {
-    /**
-     * Date of the event in the format YYYY-MM-DD.
-     */
-    date: string;
-    /**
-     * Number of occurrences.
-     */
-    count: number;
-};
-//# sourceMappingURL=userWithDate.d.ts.map

package/dist/client-analytics/model/userWithDate.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"userWithDate.d.ts","sourceRoot":"","sources":["../../../../client-analytics/model/userWithDate.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}