@algolia/client-search 5.41.0 → 5.42.0

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 (24) hide show
  1. package/README.md +4 -4
  2. package/dist/browser.d.ts +10 -1
  3. package/dist/builds/browser.js +10 -1
  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 +10 -1
  9. package/dist/builds/fetch.js.map +1 -1
  10. package/dist/builds/node.cjs +10 -1
  11. package/dist/builds/node.cjs.map +1 -1
  12. package/dist/builds/node.js +10 -1
  13. package/dist/builds/node.js.map +1 -1
  14. package/dist/builds/worker.js +10 -1
  15. package/dist/builds/worker.js.map +1 -1
  16. package/dist/fetch.d.ts +10 -1
  17. package/dist/node.d.cts +10 -1
  18. package/dist/node.d.ts +10 -1
  19. package/dist/src/searchClient.cjs +10 -1
  20. package/dist/src/searchClient.cjs.map +1 -1
  21. package/dist/src/searchClient.js +10 -1
  22. package/dist/src/searchClient.js.map +1 -1
  23. package/dist/worker.d.ts +10 -1
  24. package/package.json +6 -6
package/README.md CHANGED
@@ -40,11 +40,11 @@ All of our clients comes with type definition, and are available for both browse
40
40
  ### With a package manager
41
41
 
42
42
  ```bash
43
- yarn add @algolia/client-search@5.41.0
43
+ yarn add @algolia/client-search@5.42.0
44
44
  # or
45
- npm install @algolia/client-search@5.41.0
45
+ npm install @algolia/client-search@5.42.0
46
46
  # or
47
- pnpm add @algolia/client-search@5.41.0
47
+ pnpm add @algolia/client-search@5.42.0
48
48
  ```
49
49
 
50
50
  ### Without a package manager
@@ -52,7 +52,7 @@ pnpm add @algolia/client-search@5.41.0
52
52
  Add the following JavaScript snippet to the <head> of your website:
53
53
 
54
54
  ```html
55
- <script src="https://cdn.jsdelivr.net/npm/@algolia/client-search@5.41.0/dist/builds/browser.umd.js"></script>
55
+ <script src="https://cdn.jsdelivr.net/npm/@algolia/client-search@5.42.0/dist/builds/browser.umd.js"></script>
56
56
  ```
57
57
 
58
58
  ### Usage
package/dist/browser.d.ts CHANGED
@@ -3052,7 +3052,7 @@ type AccountCopyIndexOptions = {
3052
3052
  batchSize?: number | undefined;
3053
3053
  };
3054
3054
 
3055
- declare const apiClientVersion = "5.41.0";
3055
+ declare const apiClientVersion = "5.42.0";
3056
3056
  declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
3057
3057
  transporter: _algolia_client_common.Transporter;
3058
3058
  /**
@@ -3290,6 +3290,9 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3290
3290
  assignUserId({ xAlgoliaUserID, assignUserIdParams }: AssignUserIdProps, requestOptions?: RequestOptions): Promise<CreatedAtResponse>;
3291
3291
  /**
3292
3292
  * Adds, updates, or deletes records in one index with a single API request. Batching index updates reduces latency and increases data integrity. - Actions are applied in the order they\'re specified. - Actions are equivalent to the individual API requests of the same name. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
3293
+ *
3294
+ * Required API Key ACLs:
3295
+ * - addObject
3293
3296
  * @param batch - The batch object.
3294
3297
  * @param batch.indexName - Name of the index on which to perform the operation.
3295
3298
  * @param batch.batchWriteParams - The batchWriteParams object.
@@ -3475,6 +3478,9 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3475
3478
  deleteSynonym({ indexName, objectID, forwardToReplicas }: DeleteSynonymProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
3476
3479
  /**
3477
3480
  * Gets the permissions and restrictions of an API key. When authenticating with the admin API key, you can request information for any of your application\'s keys. When authenticating with other API keys, you can only retrieve information for that key, with the description replaced by `<redacted>`.
3481
+ *
3482
+ * Required API Key ACLs:
3483
+ * - search
3478
3484
  * @param getApiKey - The getApiKey object.
3479
3485
  * @param getApiKey.key - API key.
3480
3486
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3672,6 +3678,9 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3672
3678
  listUserIds({ page, hitsPerPage }?: ListUserIdsProps, requestOptions?: RequestOptions | undefined): Promise<ListUserIdsResponse>;
3673
3679
  /**
3674
3680
  * Adds, updates, or deletes records in multiple indices with a single API request. - Actions are applied in the order they are specified. - Actions are equivalent to the individual API requests of the same name. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
3681
+ *
3682
+ * Required API Key ACLs:
3683
+ * - addObject
3675
3684
  * @param batchParams - The batchParams object.
3676
3685
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3677
3686
  */
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.41.0";
19
+ var apiClientVersion = "5.42.0";
20
20
  function getDefaultHosts(appId) {
21
21
  return [
22
22
  {
@@ -663,6 +663,9 @@ function createSearchClient({
663
663
  },
664
664
  /**
665
665
  * Adds, updates, or deletes records in one index with a single API request. Batching index updates reduces latency and increases data integrity. - Actions are applied in the order they\'re specified. - Actions are equivalent to the individual API requests of the same name. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
666
+ *
667
+ * Required API Key ACLs:
668
+ * - addObject
666
669
  * @param batch - The batch object.
667
670
  * @param batch.indexName - Name of the index on which to perform the operation.
668
671
  * @param batch.batchWriteParams - The batchWriteParams object.
@@ -1161,6 +1164,9 @@ function createSearchClient({
1161
1164
  },
1162
1165
  /**
1163
1166
  * Gets the permissions and restrictions of an API key. When authenticating with the admin API key, you can request information for any of your application\'s keys. When authenticating with other API keys, you can only retrieve information for that key, with the description replaced by `<redacted>`.
1167
+ *
1168
+ * Required API Key ACLs:
1169
+ * - search
1164
1170
  * @param getApiKey - The getApiKey object.
1165
1171
  * @param getApiKey.key - API key.
1166
1172
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1643,6 +1649,9 @@ function createSearchClient({
1643
1649
  },
1644
1650
  /**
1645
1651
  * Adds, updates, or deletes records in multiple indices with a single API request. - Actions are applied in the order they are specified. - Actions are equivalent to the individual API requests of the same name. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
1652
+ *
1653
+ * Required API Key ACLs:
1654
+ * - addObject
1646
1655
  * @param batchParams - The batchParams object.
1647
1656
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1648
1657
  */