algoliasearch 5.0.0-alpha.8 → 5.0.0-alpha.80

package/lite/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/lite/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/lite/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 hits by tags](https://www.algolia.com/doc/api-reference/api-parameters/tagFilters/).
  */
 export type TagFilters = MixedSearchFilters[] | string;

package/lite/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.
 
+/**
+ * _published_ if the task has been processed, _notPublished_ otherwise.
+ */
 export type TaskStatus = 'notPublished' | 'published';

package/lite/model/timeRange.ts

@@ -1,4 +1,4 @@
-// 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 = {
   /**

package/lite/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.
+ * Controls whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.
  */
 export type TypoTolerance = TypoToleranceEnum | boolean;

package/lite/model/typoToleranceEnum.ts

@@ -1,3 +1,3 @@
-// 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 TypoToleranceEnum = 'min' | 'strict';

package/lite/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 object identifier.
    */
   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 and this `taskID`.
    */
   taskID: number;
 };

package/lite/model/userId.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.
 
 /**
- * A userID.
+ * Unique user ID.
  */
 export type UserId = {
   /**
@@ -10,7 +10,7 @@ export type UserId = {
   userID: string;
 
   /**
-   * Cluster on which the user is assigned.
+   * Cluster to which the user is assigned.
    */
   clusterName: string;
 

package/lite/model/value.ts

@@ -1,4 +1,4 @@
-// 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';
 

package/lite/src/liteClient.ts

@@ -1,4 +1,4 @@
-// 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 {
   createAuth,
@@ -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.8';
+export const apiClientVersion = '5.0.0-alpha.80';
 
 function getDefaultHosts(appId: string): Host[] {
   return (
@@ -127,9 +127,9 @@ export function createLiteClient({
      *
      * @summary Send requests to the Algolia REST API.
      * @param post - The post object.
-     * @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-     * @param post.parameters - Query parameters to be applied to the current query.
-     * @param post.body - The parameters to send with the custom request.
+     * @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 requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     post(
@@ -156,10 +156,10 @@ export function createLiteClient({
     },
 
     /**
-     * Perform a search operation targeting one or many indices.
+     * Send multiple search queries to one or more indices.
      *
      * @summary Search multiple indices.
-     * @param searchMethodParams - The `search` requests and strategy.
+     * @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<T>(

package/lite.js

@@ -1,2 +1,2 @@
 // eslint-disable-next-line import/no-commonjs,import/extensions
-module.exports = require('./dist/lite/lite.cjs.js');
+module.exports = require('./dist/lite/lite.cjs');

package/package.json

@@ -1,20 +1,21 @@
 {
   "name": "algoliasearch",
-  "version": "5.0.0-alpha.8",
+  "version": "5.0.0-alpha.80",
   "description": "A fully-featured and blazing-fast JavaScript API client to interact with Algolia API.",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
   "author": "Algolia",
+  "type": "module",
   "exports": {
     ".": {
       "types": "./index.d.ts",
       "node": {
         "import": "./dist/algoliasearch.esm.node.js",
         "module": "./dist/algoliasearch.esm.node.js",
-        "require": "./dist/algoliasearch.cjs.js",
-        "default": "./dist/algoliasearch.cjs.js"
+        "require": "./dist/algoliasearch.cjs",
+        "default": "./dist/algoliasearch.cjs"
       },
-      "browser": {
+      "default": {
         "umd": "./dist/algoliasearch.umd.js",
         "module": "./dist/algoliasearch.esm.browser.js",
         "import": "./dist/algoliasearch.esm.browser.js",
@@ -26,10 +27,10 @@
       "node": {
         "import": "./dist/lite/lite.esm.node.js",
         "module": "./dist/lite/lite.esm.node.js",
-        "require": "./dist/lite/lite.cjs.js",
-        "default": "./dist/lite/lite.cjs.js"
+        "require": "./dist/lite/lite.cjs",
+        "default": "./dist/lite/lite.cjs"
       },
-      "browser": {
+      "default": {
         "umd": "./dist/lite/lite.umd.js",
         "module": "./dist/lite/lite.esm.browser.js",
         "import": "./dist/lite/lite.esm.browser.js",
@@ -43,7 +44,7 @@
     "./index.js": "./dist/algoliasearch.umd.js",
     "./lite.js": "./dist/lite/lite.umd.js"
   },
-  "types": "index.d.ts",
+  "types": "./index.d.ts",
   "files": [
     "dist",
     "builds",
@@ -59,21 +60,21 @@
     "test": "jest"
   },
   "dependencies": {
-    "@algolia/client-abtesting": "5.0.0-alpha.8",
-    "@algolia/client-analytics": "5.0.0-alpha.8",
-    "@algolia/client-common": "5.0.0-alpha.8",
-    "@algolia/client-personalization": "5.0.0-alpha.8",
-    "@algolia/client-search": "5.0.0-alpha.8",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.8",
-    "@algolia/requester-node-http": "5.0.0-alpha.8"
+    "@algolia/client-abtesting": "5.0.0-alpha.80",
+    "@algolia/client-analytics": "5.0.0-alpha.80",
+    "@algolia/client-common": "5.0.0-alpha.80",
+    "@algolia/client-personalization": "5.0.0-alpha.80",
+    "@algolia/client-search": "5.0.0-alpha.80",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.80",
+    "@algolia/requester-node-http": "5.0.0-alpha.80"
   },
   "devDependencies": {
-    "@types/jest": "28.1.6",
-    "@types/node": "16.11.47",
-    "jest": "28.1.3",
-    "rollup": "2.77.2",
-    "ts-jest": "28.0.7",
-    "typescript": "4.7.4"
+    "@types/jest": "29.5.4",
+    "@types/node": "18.17.12",
+    "jest": "29.6.4",
+    "rollup": "3.28.1",
+    "ts-jest": "29.1.1",
+    "typescript": "5.2.2"
   },
   "engines": {
     "node": ">= 14.0.0"

package/dist/builds/models.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../builds/models.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EACL,SAAS,EACT,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,QAAQ,EACT,MAAM,8BAA8B,CAAC;AAEtC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,uCAAuC,CAAC;AACtD,cAAc,iCAAiC,CAAC;AAChD,cAAc,iCAAiC,CAAC;AAEhD,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAE5D,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;AAE9D;;GAEG;AACH,oBAAY,iBAAiB,GAAG,OAAO,CAAC;IACtC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,aAAa,CAAC;CACxB,CAAC,CAAC;AAEH,oBAAY,gBAAgB,CAAC,OAAO,IAAI,OAAO,CAAC;IAC9C;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC,CAAC"}

package/dist/client-search/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/client-search/model/synonymHitHighlightResult.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"synonymHitHighlightResult.d.ts","sourceRoot":"","sources":["../../../../client-search/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/dist/lite/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/lite/model/synonymHitHighlightResult.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"synonymHitHighlightResult.d.ts","sourceRoot":"","sources":["../../../lite/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/lite/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>>;
-};