algoliasearch 5.0.0-alpha.106 → 5.0.0-alpha.108

package/lite/model/searchSynonymsResponse.ts

@@ -4,12 +4,12 @@ import type { SynonymHit } from './synonymHit';
 
 export type SearchSynonymsResponse = Record<string, any> & {
   /**
-   * Synonym objects.
+   * Matching synonyms.
    */
   hits: SynonymHit[];
 
   /**
-   * Number of hits the search query matched.
+   * Number of results (hits).
    */
   nbHits: number;
 };

package/lite/model/securedAPIKeyRestrictions.ts

@@ -6,27 +6,27 @@ export type SecuredAPIKeyRestrictions = {
   searchParams?: SearchParamsObject;
 
   /**
-   * Filters that apply to every search made with the secured API key. You can add extra filters at search time with the filters query parameter. For example, if you set the filter group:admin on your generated API key, and you add groups:press OR groups:visitors with the filters query parameter, your final search filter is equivalent to groups:admin AND (groups:press OR groups:visitors).
+   * Filters that apply to every search made with the secured API key. Extra filters added at search time will be combined with `AND`. For example, if you set `group:admin` as fixed filter on your generated API key, and add `groups:visitors` to the search query, the complete set of filters will be `group:admin AND groups:visitors`.
    */
   filters?: string;
 
   /**
-   * Unix timestamp used to set the expiration date of the API key.
+   * Timestamp in [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time) when the API key should expire.
    */
   validUntil?: number;
 
   /**
-   * Index names that can be queried.
+   * Index names or patterns that this API key can access. By default, an API key can access all indices in the same application.  You can use leading and trailing wildcard characters (`*`):  - `dev_*` matches all indices starting with \"dev_\". - `*_dev` matches all indices ending with \"_dev\". - `*_products_*` matches all indices containing \"_products_\".
    */
   restrictIndices?: string[];
 
   /**
-   * IPv4 network allowed to use the generated key. Use this to protect against API key leaking and reuse. You can only provide a single source, but you can specify a range of IPs (for example, 192.168.1.0/24).
+   * IP network that are allowed to use this key.  You can only add a single source, but you can provide a range of IP addresses. Use this to protect against API key leaking and reuse.
    */
   restrictSources?: string;
 
   /**
-   * Unique user IP address. This can be useful when you want to impose a rate limit on specific users. By default, rate limits are set based on the IP address. This can become an issue when several users search from the same IP address. To avoid this, you can set a unique userToken for each user when generating their API key. This lets you restrict each user to a maximum number of API calls per hour, even if they share their IP with another user. Specifying the userToken in a secured API key is also a good security practice as it ensures users don\'t change it. Many features like Analytics, Personalization, and Dynamic Re-ranking rely on the authenticity of user identifiers. Setting the userToken at the API key level ensures that downstream services work as expected and prevents abuse.
+   * Pseudonymous user identifier to restrict usage of this API key to specific users.  By default, rate limits are set based on IP addresses. This can be an issue if many users search from the same IP address. To avoid this, add a user token to each generated API key.
    */
   userToken?: string;
 };

package/lite/model/semanticSearch.ts

@@ -1,11 +1,11 @@
 // 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.
 
 /**
- * Settings for the semantic search part of NeuralSearch. Only used when `mode` is _neuralSearch_.
+ * Settings for the semantic search part of NeuralSearch. Only used when `mode` is `neuralSearch`.
  */
 export type SemanticSearch = {
   /**
-   * Indices from which to collect click and conversion events. If null, the current index and replica group will be used as the event source.
+   * Indices from which to collect click and conversion events.  If null, the current index and all its replicas are used.
    */
   eventSources?: string[] | null;
 };

package/lite/model/snippetResultOption.ts

@@ -3,11 +3,11 @@
 import type { MatchLevel } from './matchLevel';
 
 /**
- * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+ * Snippets that show the context around a matching search query.
  */
 export type SnippetResultOption = {
   /**
-   * Markup text with `facetQuery` matches highlighted.
+   * Highlighted attribute value, including HTML tags.
    */
   value: string;
 

package/lite/model/sortRemainingBy.ts

@@ -1,6 +1,6 @@
 // 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.
 
 /**
- * How to display the remaining items:    - `count`: facet count (descending).   - `alpha`: alphabetical (ascending).   - `hidden`: show only pinned values.
+ * Order of facet values that aren\'t explicitly positioned with the `order` setting.  <dl> <dt><code>count</code></dt> <dd> Order remaining facet values by decreasing count. The count is the number of matching records containing this facet value. </dd> <dt><code>alpha</code></dt> <dd>Sort facet values alphabetically.</dd> <dt><code>hidden</code></dt> <dd>Don\'t show facet values that aren\'t explicitly positioned.</dd> </dl>.
  */
 export type SortRemainingBy = 'alpha' | 'count' | 'hidden';

package/lite/model/supportedLanguage.ts

@@ -0,0 +1,74 @@
+// 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.
+
+/**
+ * ISO code for a supported language.
+ */
+export type SupportedLanguage =
+  | 'af'
+  | 'ar'
+  | 'az'
+  | 'bg'
+  | 'bn'
+  | 'ca'
+  | 'cs'
+  | 'cy'
+  | 'da'
+  | 'de'
+  | 'el'
+  | 'en'
+  | 'eo'
+  | 'es'
+  | 'et'
+  | 'eu'
+  | 'fa'
+  | 'fi'
+  | 'fo'
+  | 'fr'
+  | 'ga'
+  | 'gl'
+  | 'he'
+  | 'hi'
+  | 'hu'
+  | 'hy'
+  | 'id'
+  | 'is'
+  | 'it'
+  | 'ja'
+  | 'ka'
+  | 'kk'
+  | 'ko'
+  | 'ku'
+  | 'ky'
+  | 'lt'
+  | 'lv'
+  | 'mi'
+  | 'mn'
+  | 'mr'
+  | 'ms'
+  | 'mt'
+  | 'nb'
+  | 'nl'
+  | 'no'
+  | 'ns'
+  | 'pl'
+  | 'ps'
+  | 'pt-br'
+  | 'pt'
+  | 'qu'
+  | 'ro'
+  | 'ru'
+  | 'sk'
+  | 'sq'
+  | 'sv'
+  | 'sw'
+  | 'ta'
+  | 'te'
+  | 'th'
+  | 'tl'
+  | 'tn'
+  | 'tr'
+  | 'tt'
+  | 'uk'
+  | 'ur'
+  | 'uz'
+  | 'zh';

package/lite/model/tagFilters.ts

@@ -3,6 +3,6 @@
 import type { MixedSearchFilters } from './mixedSearchFilters';
 
 /**
- * [Filter hits by tags](https://www.algolia.com/doc/api-reference/api-parameters/tagFilters/).
+ * Filter the search by values of the special `_tags` attribute.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  Different from regular facets, `_tags` can only be used for filtering (including or excluding records). You won\'t get a facet count. The same combination and escaping rules apply as for `facetFilters`.
  */
 export type TagFilters = MixedSearchFilters[] | string;

package/lite/model/taskStatus.ts

@@ -1,6 +1,6 @@
 // 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.
 
 /**
- * _published_ if the task has been processed, _notPublished_ otherwise.
+ * Task status, `published` if the task is completed, `notPublished` otherwise.
  */
 export type TaskStatus = 'notPublished' | 'published';

package/lite/model/timeRange.ts

@@ -2,12 +2,12 @@
 
 export type TimeRange = {
   /**
-   * Lower bound of the time range (Unix timestamp).
+   * When the rule should start to be active, in Unix epoch time.
    */
   from: number;
 
   /**
-   * Upper bound of the time range (Unix timestamp).
+   * When the rule should stop to be active, in Unix epoch time.
    */
   until: number;
 };

package/lite/model/typoTolerance.ts

@@ -3,6 +3,6 @@
 import type { TypoToleranceEnum } from './typoToleranceEnum';
 
 /**
- * Controls whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.
+ * Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.  If typo tolerance is true, `min`, or `strict`, [word splitting and concetenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) is also active.
  */
 export type TypoTolerance = TypoToleranceEnum | boolean;

package/lite/model/typoToleranceEnum.ts

@@ -1,3 +1,6 @@
 // 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.
 
+/**
+ * - `min`. Return matches with the lowest number of typos.   For example, if you have matches without typos, only include those.   But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - `strict`. Return matches with the two lowest numbers of typos.   With `strict`, the Typo ranking criterion is applied first in the `ranking` setting.
+ */
 export type TypoToleranceEnum = 'min' | 'strict';

package/lite/model/updatedRuleResponse.ts

@@ -2,7 +2,7 @@
 
 export type UpdatedRuleResponse = {
   /**
-   * Unique object identifier.
+   * Unique identifier of a rule object.
    */
   objectID: string;
 
@@ -12,7 +12,7 @@ export type UpdatedRuleResponse = {
   updatedAt: string;
 
   /**
-   * Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the `task` operation and this `taskID`.
+   * Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
    */
   taskID: number;
 };

package/lite/model/userId.ts

@@ -5,7 +5,7 @@
  */
 export type UserId = {
   /**
-   * UserID of the user.
+   * User ID.
    */
   userID: string;
 

package/lite/model/value.ts

@@ -4,7 +4,7 @@ import type { SortRemainingBy } from './sortRemainingBy';
 
 export type Value = {
   /**
-   * Pinned order of facet lists.
+   * Explicit order of facets or facet values.  This setting lets you always show specific facets or facet values at the top of the list.
    */
   order?: string[];
 

package/lite/src/liteClient.ts

@@ -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.106';
+export const apiClientVersion = '5.0.0-alpha.108';
 
 function getDefaultHosts(appId: string): Host[] {
   return (
@@ -157,12 +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.
      *
      * Required API Key ACLs:
      * - search.
      *
-     * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
+     * @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>(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "algoliasearch",
-  "version": "5.0.0-alpha.106",
+  "version": "5.0.0-alpha.108",
   "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.106",
-    "@algolia/client-analytics": "5.0.0-alpha.106",
-    "@algolia/client-common": "5.0.0-alpha.107",
-    "@algolia/client-personalization": "5.0.0-alpha.106",
-    "@algolia/client-search": "5.0.0-alpha.106",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.107",
-    "@algolia/requester-node-http": "5.0.0-alpha.107"
+    "@algolia/client-abtesting": "5.0.0-alpha.108",
+    "@algolia/client-analytics": "5.0.0-alpha.108",
+    "@algolia/client-common": "5.0.0-alpha.109",
+    "@algolia/client-personalization": "5.0.0-alpha.108",
+    "@algolia/client-search": "5.0.0-alpha.108",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.109",
+    "@algolia/requester-node-http": "5.0.0-alpha.109"
   },
   "devDependencies": {
     "@babel/preset-env": "7.24.0",
     "@babel/preset-typescript": "7.23.3",
     "@types/jest": "29.5.12",
-    "@types/node": "20.11.24",
+    "@types/node": "20.11.28",
     "jest": "29.7.0",
-    "rollup": "4.12.0",
-    "typescript": "5.3.3"
+    "rollup": "4.13.0",
+    "typescript": "5.4.2"
   },
   "engines": {
     "node": ">= 14.0.0"