@algolia/client-search 5.23.0 → 5.23.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 (24) hide show
  1. package/README.md +4 -4
  2. package/dist/browser.d.ts +19 -1
  3. package/dist/builds/browser.js +19 -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 +19 -1
  9. package/dist/builds/fetch.js.map +1 -1
  10. package/dist/builds/node.cjs +19 -1
  11. package/dist/builds/node.cjs.map +1 -1
  12. package/dist/builds/node.js +19 -1
  13. package/dist/builds/node.js.map +1 -1
  14. package/dist/builds/worker.js +19 -1
  15. package/dist/builds/worker.js.map +1 -1
  16. package/dist/fetch.d.ts +19 -1
  17. package/dist/node.d.cts +19 -1
  18. package/dist/node.d.ts +19 -1
  19. package/dist/src/searchClient.cjs +19 -1
  20. package/dist/src/searchClient.cjs.map +1 -1
  21. package/dist/src/searchClient.js +19 -1
  22. package/dist/src/searchClient.js.map +1 -1
  23. package/dist/worker.d.ts +19 -1
  24. package/package.json +7 -7
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.23.0
44
+ yarn add @algolia/client-search@5.23.1
45
45
  # or
46
- npm install @algolia/client-search@5.23.0
46
+ npm install @algolia/client-search@5.23.1
47
47
  # or
48
- pnpm add @algolia/client-search@5.23.0
48
+ pnpm add @algolia/client-search@5.23.1
49
49
  ```
50
50
 
51
51
  ### Without a package manager
@@ -53,7 +53,7 @@ pnpm add @algolia/client-search@5.23.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.23.0/dist/builds/browser.umd.js"></script>
56
+ <script src="https://cdn.jsdelivr.net/npm/@algolia/client-search@5.23.1/dist/builds/browser.umd.js"></script>
57
57
  ```
58
58
 
59
59
  ### Usage
package/dist/browser.d.ts CHANGED
@@ -3028,7 +3028,7 @@ type ReplaceAllObjectsOptions = {
3028
3028
  scopes?: Array<ScopeType>;
3029
3029
  };
3030
3030
 
3031
- declare const apiClientVersion = "5.23.0";
3031
+ declare const apiClientVersion = "5.23.1";
3032
3032
  declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
3033
3033
  transporter: _algolia_client_common.Transporter;
3034
3034
  /**
@@ -3256,6 +3256,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3256
3256
  *
3257
3257
  * Required API Key ACLs:
3258
3258
  * - admin
3259
+ *
3260
+ * @deprecated
3259
3261
  * @param assignUserId - The assignUserId object.
3260
3262
  * @param assignUserId.xAlgoliaUserID - Unique identifier of the user who makes the search request.
3261
3263
  * @param assignUserId.assignUserIdParams - The assignUserIdParams object.
@@ -3275,6 +3277,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3275
3277
  *
3276
3278
  * Required API Key ACLs:
3277
3279
  * - admin
3280
+ *
3281
+ * @deprecated
3278
3282
  * @param batchAssignUserIds - The batchAssignUserIds object.
3279
3283
  * @param batchAssignUserIds.xAlgoliaUserID - Unique identifier of the user who makes the search request.
3280
3284
  * @param batchAssignUserIds.batchAssignUserIdsParams - The batchAssignUserIdsParams object.
@@ -3570,6 +3574,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3570
3574
  *
3571
3575
  * Required API Key ACLs:
3572
3576
  * - admin
3577
+ *
3578
+ * @deprecated
3573
3579
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3574
3580
  */
3575
3581
  getTopUserIds(requestOptions?: RequestOptions): Promise<GetTopUserIdsResponse>;
@@ -3578,6 +3584,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3578
3584
  *
3579
3585
  * Required API Key ACLs:
3580
3586
  * - admin
3587
+ *
3588
+ * @deprecated
3581
3589
  * @param getUserId - The getUserId object.
3582
3590
  * @param getUserId.userID - Unique identifier of the user who makes the search request.
3583
3591
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3588,6 +3596,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3588
3596
  *
3589
3597
  * Required API Key ACLs:
3590
3598
  * - admin
3599
+ *
3600
+ * @deprecated
3591
3601
  * @param hasPendingMappings - The hasPendingMappings object.
3592
3602
  * @param hasPendingMappings.getClusters - Whether to include the cluster\'s pending mapping state in the response.
3593
3603
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3606,6 +3616,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3606
3616
  *
3607
3617
  * Required API Key ACLs:
3608
3618
  * - admin
3619
+ *
3620
+ * @deprecated
3609
3621
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3610
3622
  */
3611
3623
  listClusters(requestOptions?: RequestOptions): Promise<ListClustersResponse>;
@@ -3625,6 +3637,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3625
3637
  *
3626
3638
  * Required API Key ACLs:
3627
3639
  * - admin
3640
+ *
3641
+ * @deprecated
3628
3642
  * @param listUserIds - The listUserIds object.
3629
3643
  * @param listUserIds.page - Requested page of the API response. If `null`, the API response is not paginated.
3630
3644
  * @param listUserIds.hitsPerPage - Number of hits per page.
@@ -3666,6 +3680,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3666
3680
  *
3667
3681
  * Required API Key ACLs:
3668
3682
  * - admin
3683
+ *
3684
+ * @deprecated
3669
3685
  * @param removeUserId - The removeUserId object.
3670
3686
  * @param removeUserId.userID - Unique identifier of the user who makes the search request.
3671
3687
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3824,6 +3840,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3824
3840
  *
3825
3841
  * Required API Key ACLs:
3826
3842
  * - admin
3843
+ *
3844
+ * @deprecated
3827
3845
  * @param searchUserIdsParams - The searchUserIdsParams object.
3828
3846
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3829
3847
  */
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.23.0";
19
+ var apiClientVersion = "5.23.1";
20
20
  function getDefaultHosts(appId) {
21
21
  return [
22
22
  {
@@ -629,6 +629,8 @@ function createSearchClient({
629
629
  *
630
630
  * Required API Key ACLs:
631
631
  * - admin
632
+ *
633
+ * @deprecated
632
634
  * @param assignUserId - The assignUserId object.
633
635
  * @param assignUserId.xAlgoliaUserID - Unique identifier of the user who makes the search request.
634
636
  * @param assignUserId.assignUserIdParams - The assignUserIdParams object.
@@ -693,6 +695,8 @@ function createSearchClient({
693
695
  *
694
696
  * Required API Key ACLs:
695
697
  * - admin
698
+ *
699
+ * @deprecated
696
700
  * @param batchAssignUserIds - The batchAssignUserIds object.
697
701
  * @param batchAssignUserIds.xAlgoliaUserID - Unique identifier of the user who makes the search request.
698
702
  * @param batchAssignUserIds.batchAssignUserIdsParams - The batchAssignUserIdsParams object.
@@ -1467,6 +1471,8 @@ function createSearchClient({
1467
1471
  *
1468
1472
  * Required API Key ACLs:
1469
1473
  * - admin
1474
+ *
1475
+ * @deprecated
1470
1476
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1471
1477
  */
1472
1478
  getTopUserIds(requestOptions) {
@@ -1486,6 +1492,8 @@ function createSearchClient({
1486
1492
  *
1487
1493
  * Required API Key ACLs:
1488
1494
  * - admin
1495
+ *
1496
+ * @deprecated
1489
1497
  * @param getUserId - The getUserId object.
1490
1498
  * @param getUserId.userID - Unique identifier of the user who makes the search request.
1491
1499
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1510,6 +1518,8 @@ function createSearchClient({
1510
1518
  *
1511
1519
  * Required API Key ACLs:
1512
1520
  * - admin
1521
+ *
1522
+ * @deprecated
1513
1523
  * @param hasPendingMappings - The hasPendingMappings object.
1514
1524
  * @param hasPendingMappings.getClusters - Whether to include the cluster\'s pending mapping state in the response.
1515
1525
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1553,6 +1563,8 @@ function createSearchClient({
1553
1563
  *
1554
1564
  * Required API Key ACLs:
1555
1565
  * - admin
1566
+ *
1567
+ * @deprecated
1556
1568
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1557
1569
  */
1558
1570
  listClusters(requestOptions) {
@@ -1600,6 +1612,8 @@ function createSearchClient({
1600
1612
  *
1601
1613
  * Required API Key ACLs:
1602
1614
  * - admin
1615
+ *
1616
+ * @deprecated
1603
1617
  * @param listUserIds - The listUserIds object.
1604
1618
  * @param listUserIds.page - Requested page of the API response. If `null`, the API response is not paginated.
1605
1619
  * @param listUserIds.hitsPerPage - Number of hits per page.
@@ -1724,6 +1738,8 @@ function createSearchClient({
1724
1738
  *
1725
1739
  * Required API Key ACLs:
1726
1740
  * - admin
1741
+ *
1742
+ * @deprecated
1727
1743
  * @param removeUserId - The removeUserId object.
1728
1744
  * @param removeUserId.userID - Unique identifier of the user who makes the search request.
1729
1745
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2196,6 +2212,8 @@ function createSearchClient({
2196
2212
  *
2197
2213
  * Required API Key ACLs:
2198
2214
  * - admin
2215
+ *
2216
+ * @deprecated
2199
2217
  * @param searchUserIdsParams - The searchUserIdsParams object.
2200
2218
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2201
2219
  */