@algolia/client-search 5.0.0-alpha.11 → 5.0.0-alpha.110

package/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/model/synonymHit.ts

@@ -1,6 +1,5 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { SynonymHitHighlightResult } from './synonymHitHighlightResult';
 import type { SynonymType } from './synonymType';
 
 /**
@@ -8,24 +7,24 @@ import type { SynonymType } from './synonymType';
  */
 export type SynonymHit = {
   /**
-   * Unique identifier of the synonym object to be created or updated.
+   * Unique identifier of a synonym object.
    */
   objectID: string;
 
   type: SynonymType;
 
   /**
-   * Words or phrases to be considered equivalent.
+   * Words or phrases considered equivalent.
    */
   synonyms?: string[];
 
   /**
-   * Word or phrase to appear in query strings (for onewaysynonym).
+   * Word or phrase to appear in query strings (for [`onewaysynonym`s](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/one-way-synonyms/)).
    */
   input?: string;
 
   /**
-   * Word or phrase to appear in query strings (for altcorrection1 and altcorrection2).
+   * Word or phrase to appear in query strings (for [`altcorrection1` and `altcorrection2`](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-alternative-corrections/)).
    */
   word?: string;
 
@@ -35,14 +34,12 @@ export type SynonymHit = {
   corrections?: string[];
 
   /**
-   * Token to be put inside records.
+   * [Placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/) to be put inside records.
    */
   placeholder?: string;
 
   /**
-   * List of query words that will match the token.
+   * Query words that will match the [placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/).
    */
   replacements?: string[];
-
-  _highlightResult?: SynonymHitHighlightResult;
 };

package/model/synonymType.ts

@@ -1,7 +1,7 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
 /**
- * Type of the synonym object.
+ * Synonym type.
  */
 export type SynonymType =
   | 'altcorrection1'

package/model/tagFilters.ts

@@ -1,8 +1,8 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { MixedSearchFilters } from './mixedSearchFilters';
 
 /**
- * Filter hits by tags.
+ * 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/model/taskStatus.ts

@@ -1,3 +1,6 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
+/**
+ * Task status, `published` if the task is completed, `notPublished` otherwise.
+ */
 export type TaskStatus = 'notPublished' | 'published';

package/model/timeRange.ts

@@ -1,13 +1,13 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
 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/model/typoTolerance.ts

@@ -1,8 +1,8 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { TypoToleranceEnum } from './typoToleranceEnum';
 
 /**
- * Controls whether 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/model/typoToleranceEnum.ts

@@ -1,3 +1,6 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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/model/updateApiKeyResponse.ts

@@ -1,13 +1,13 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
 export type UpdateApiKeyResponse = {
   /**
-   * The API key.
+   * API key.
    */
   key: string;
 
   /**
-   * Date of last update (ISO-8601 format).
+   * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
    */
   updatedAt: string;
 };

package/model/updatedAtResponse.ts

@@ -1,16 +1,16 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
 /**
- * The response with a taskID and an updatedAt timestamp.
+ * Response, taskID, and update timestamp.
  */
 export type UpdatedAtResponse = {
   /**
-   * TaskID of the task to wait for.
+   * 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;
 
   /**
-   * Date of last update (ISO-8601 format).
+   * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
    */
   updatedAt: string;
 };

package/model/updatedAtWithObjectIdResponse.ts

@@ -1,21 +1,21 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
 /**
- * The response with a taskID, an objectID and an updatedAt timestamp.
+ * Response, taskID, unique object identifier, and an update timestamp.
  */
 export type UpdatedAtWithObjectIdResponse = {
   /**
-   * TaskID of the task to wait for.
+   * 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;
 
   /**
-   * Date of last update (ISO-8601 format).
+   * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
    */
   updatedAt?: string;
 
   /**
-   * Unique identifier of the object.
+   * Unique record identifier.
    */
   objectID?: string;
 };

package/model/updatedRuleResponse.ts

@@ -1,18 +1,18 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
 export type UpdatedRuleResponse = {
   /**
-   * Unique identifier of the object.
+   * Unique identifier of a rule object.
    */
   objectID: string;
 
   /**
-   * Date of last update (ISO-8601 format).
+   * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
    */
   updatedAt: string;
 
   /**
-   * TaskID of the task to wait for.
+   * 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/model/userHighlightResult.ts

@@ -1,15 +1,9 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { 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/model/userHit.ts

@@ -1,15 +1,15 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { UserHighlightResult } from './userHighlightResult';
 
 export type UserHit = {
   /**
-   * UserID of the user.
+   * User ID.
    */
   userID: string;
 
   /**
-   * Name of the cluster.
+   * Cluster name.
    */
   clusterName: string;
 

package/model/userId.ts

@@ -1,16 +1,16 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
 /**
- * A userID.
+ * Unique user ID.
  */
 export type UserId = {
   /**
-   * UserID of the user.
+   * User ID.
    */
   userID: string;
 
   /**
-   * Cluster on which the user is assigned.
+   * Cluster to which the user is assigned.
    */
   clusterName: string;
 

package/model/value.ts

@@ -1,10 +1,10 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { 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/package.json

@@ -1,17 +1,18 @@
 {
   "name": "@algolia/client-search",
-  "version": "5.0.0-alpha.11",
+  "version": "5.0.0-alpha.110",
   "description": "JavaScript client for client-search",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
   "author": "Algolia",
+  "type": "module",
   "exports": {
     ".": {
       "node": {
         "import": "./dist/client-search.esm.node.js",
         "module": "./dist/client-search.esm.node.js",
-        "require": "./dist/client-search.cjs.js",
-        "default": "./dist/client-search.cjs.js"
+        "require": "./dist/client-search.cjs",
+        "default": "./dist/client-search.cjs"
       },
       "default": {
         "umd": "./dist/client-search.umd.js",
@@ -38,14 +39,14 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.11",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.11",
-    "@algolia/requester-node-http": "5.0.0-alpha.11"
+    "@algolia/client-common": "5.0.0-alpha.111",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.111",
+    "@algolia/requester-node-http": "5.0.0-alpha.111"
   },
   "devDependencies": {
-    "@types/node": "16.11.47",
-    "rollup": "2.78.1",
-    "typescript": "4.7.4"
+    "@types/node": "20.11.30",
+    "rollup": "4.13.2",
+    "typescript": "5.4.3"
   },
   "engines": {
     "node": ">= 14.0.0"

package/dist/model/synonymHitHighlightResult.d.ts

@@ -1,12 +0,0 @@
-import type { HighlightResult } from './highlightResult';
-/**
- * Highlighted results.
- */
-export declare type SynonymHitHighlightResult = {
-    /**
-     * Show highlighted section and words matched on a query.
-     */
-    type?: Record<string, HighlightResult>;
-    synonyms?: Array<Record<string, HighlightResult>>;
-};
-//# sourceMappingURL=synonymHitHighlightResult.d.ts.map

package/dist/model/synonymHitHighlightResult.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"synonymHitHighlightResult.d.ts","sourceRoot":"","sources":["../../model/synonymHitHighlightResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD;;GAEG;AACH,oBAAY,yBAAyB,GAAG;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAEvC,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC;CACnD,CAAC"}

package/model/synonymHitHighlightResult.ts

@@ -1,15 +0,0 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-
-import type { HighlightResult } from './highlightResult';
-
-/**
- * Highlighted results.
- */
-export type SynonymHitHighlightResult = {
-  /**
-   * Show highlighted section and words matched on a query.
-   */
-  type?: Record<string, HighlightResult>;
-
-  synonyms?: Array<Record<string, HighlightResult>>;
-};