@algolia/client-search 5.16.0 → 5.17.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (21) hide show
  1. package/README.md +4 -4
  2. package/dist/browser.d.ts +4 -4
  3. package/dist/builds/browser.js +3 -3
  4. package/dist/builds/browser.js.map +1 -1
  5. package/dist/builds/browser.min.js +1 -1
  6. package/dist/builds/browser.min.js.map +1 -1
  7. package/dist/builds/browser.umd.js +1 -1
  8. package/dist/builds/fetch.js +3 -3
  9. package/dist/builds/fetch.js.map +1 -1
  10. package/dist/builds/node.cjs +3 -3
  11. package/dist/builds/node.cjs.map +1 -1
  12. package/dist/builds/node.js +3 -3
  13. package/dist/builds/node.js.map +1 -1
  14. package/dist/fetch.d.ts +4 -4
  15. package/dist/node.d.cts +4 -4
  16. package/dist/node.d.ts +4 -4
  17. package/dist/src/searchClient.cjs +3 -3
  18. package/dist/src/searchClient.cjs.map +1 -1
  19. package/dist/src/searchClient.js +3 -3
  20. package/dist/src/searchClient.js.map +1 -1
  21. package/package.json +5 -5
package/README.md CHANGED
@@ -41,11 +41,11 @@ All of our clients comes with type definition, and are available for both browse
41
41
  ### With a package manager
42
42
 
43
43
  ```bash
44
- yarn add @algolia/client-search@5.16.0
44
+ yarn add @algolia/client-search@5.17.1
45
45
  # or
46
- npm install @algolia/client-search@5.16.0
46
+ npm install @algolia/client-search@5.17.1
47
47
  # or
48
- pnpm add @algolia/client-search@5.16.0
48
+ pnpm add @algolia/client-search@5.17.1
49
49
  ```
50
50
 
51
51
  ### Without a package manager
@@ -53,7 +53,7 @@ pnpm add @algolia/client-search@5.16.0
53
53
  Add the following JavaScript snippet to the <head> of your website:
54
54
 
55
55
  ```html
56
- <script src="https://cdn.jsdelivr.net/npm/@algolia/client-search@5.16.0/dist/builds/browser.umd.js"></script>
56
+ <script src="https://cdn.jsdelivr.net/npm/@algolia/client-search@5.17.1/dist/builds/browser.umd.js"></script>
57
57
  ```
58
58
 
59
59
  ### Usage
package/dist/browser.d.ts CHANGED
@@ -1178,7 +1178,7 @@ type BaseSearchParamsWithoutQuery = {
1178
1178
 
1179
1179
  type AdvancedSyntaxFeatures = 'exactPhrase' | 'excludeWords';
1180
1180
 
1181
- type AlternativesAsExact = 'ignorePlurals' | 'singleWordSynonym' | 'multiWordsSynonym';
1181
+ type AlternativesAsExact = 'ignorePlurals' | 'singleWordSynonym' | 'multiWordsSynonym' | 'ignoreConjugations';
1182
1182
 
1183
1183
  /**
1184
1184
  * Determines how many records of a group are included in the search results. Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature). The `distinct` setting is ignored if `attributeForDistinct` is not set.
@@ -3021,7 +3021,7 @@ type ReplaceAllObjectsOptions = {
3021
3021
  batchSize?: number;
3022
3022
  };
3023
3023
 
3024
- declare const apiClientVersion = "5.16.0";
3024
+ declare const apiClientVersion = "5.17.1";
3025
3025
  declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
3026
3026
  transporter: _algolia_client_common.Transporter;
3027
3027
  /**
@@ -3219,7 +3219,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3219
3219
  */
3220
3220
  addApiKey(apiKey: ApiKey, requestOptions?: RequestOptions): Promise<AddApiKeyResponse>;
3221
3221
  /**
3222
- * If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index. To update _some_ attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
3222
+ * If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index. If you want to use auto-generated object IDs, use the [`saveObject` operation](#tag/Records/operation/saveObject). To update _some_ attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
3223
3223
  *
3224
3224
  * Required API Key ACLs:
3225
3225
  * - addObject
@@ -3680,7 +3680,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3680
3680
  */
3681
3681
  restoreApiKey({ key }: RestoreApiKeyProps, requestOptions?: RequestOptions): Promise<AddApiKeyResponse>;
3682
3682
  /**
3683
- * Adds a record to an index or replace it. - If the record doesn\'t have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn\'t exist, a new record is added to your index. - If you add a record to an index that doesn\'t exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject). To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
3683
+ * Adds a record to an index or replaces it. - If the record doesn\'t have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn\'t exist, a new record is added to your index. - If you add a record to an index that doesn\'t exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject). To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
3684
3684
  *
3685
3685
  * Required API Key ACLs:
3686
3686
  * - addObject
package/dist/builds/browser.js CHANGED
@@ -16,7 +16,7 @@ import {
16
16
  getAlgoliaAgent,
17
17
  shuffle
18
18
  } from "@algolia/client-common";
19
- var apiClientVersion = "5.16.0";
19
+ var apiClientVersion = "5.17.1";
20
20
  function getDefaultHosts(appId) {
21
21
  return [
22
22
  {
@@ -552,7 +552,7 @@ function createSearchClient({
552
552
  return transporter.request(request, requestOptions);
553
553
  },
554
554
  /**
555
- * If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index. To update _some_ attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
555
+ * If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index. If you want to use auto-generated object IDs, use the [`saveObject` operation](#tag/Records/operation/saveObject). To update _some_ attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
556
556
  *
557
557
  * Required API Key ACLs:
558
558
  * - addObject
@@ -1780,7 +1780,7 @@ function createSearchClient({
1780
1780
  return transporter.request(request, requestOptions);
1781
1781
  },
1782
1782
  /**
1783
- * Adds a record to an index or replace it. - If the record doesn\'t have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn\'t exist, a new record is added to your index. - If you add a record to an index that doesn\'t exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject). To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
1783
+ * Adds a record to an index or replaces it. - If the record doesn\'t have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn\'t exist, a new record is added to your index. - If you add a record to an index that doesn\'t exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject). To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
1784
1784
  *
1785
1785
  * Required API Key ACLs:
1786
1786
  * - addObject