@algolia/client-search 5.6.0 → 5.7.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 (21) hide show
  1. package/README.md +15 -6
  2. package/dist/browser.d.ts +2 -2
  3. package/dist/builds/browser.js +2 -2
  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 +2 -2
  9. package/dist/builds/fetch.js.map +1 -1
  10. package/dist/builds/node.cjs +2 -2
  11. package/dist/builds/node.cjs.map +1 -1
  12. package/dist/builds/node.js +2 -2
  13. package/dist/builds/node.js.map +1 -1
  14. package/dist/fetch.d.ts +2 -2
  15. package/dist/node.d.cts +2 -2
  16. package/dist/node.d.ts +2 -2
  17. package/dist/src/searchClient.cjs +2 -2
  18. package/dist/src/searchClient.cjs.map +1 -1
  19. package/dist/src/searchClient.js +2 -2
  20. package/dist/src/searchClient.js.map +1 -1
  21. package/package.json +7 -7
package/README.md CHANGED
@@ -32,24 +32,33 @@
32
32
 
33
33
  ## 💡 Getting Started
34
34
 
35
- To get started, you first need to install @algolia/client-search (or any other available API client package).
35
+ > [!TIP]
36
+ > This API client is already a dependency of [the algoliasearch client](https://www.npmjs.com/package/algoliasearch), you don't need to manually install `@algolia/client-search` if you already have `algoliasearch` installed.
36
37
 
38
+ To get started, you first need to install @algolia/client-search (or any other available API client package).
37
39
  All of our clients comes with type definition, and are available for both browser and node environments.
38
40
 
41
+ ### With a package manager
42
+
43
+
39
44
  ```bash
40
- yarn add @algolia/client-search
45
+ yarn add @algolia/client-search@5.7.0
46
+ # or
47
+ npm install @algolia/client-search@5.7.0
41
48
  # or
42
- npm install @algolia/client-search
49
+ pnpm add @algolia/client-search@5.7.0
43
50
  ```
44
51
 
45
- Without a package manager
52
+ ### Without a package manager
46
53
 
47
54
  Add the following JavaScript snippet to the <head> of your website:
48
55
 
49
56
  ```html
50
- <script src="https://cdn.jsdelivr.net/npm/algoliasearch/dist/client-search.umd.min.js"></script>
57
+ <script src="https://cdn.jsdelivr.net/npm/@algolia/client-search@5.7.0/dist/builds/browser.umd.js"></script>
51
58
  ```
52
59
 
60
+ ### Usage
61
+
53
62
  You can now import the Algolia API client in your project and play with it.
54
63
 
55
64
  ```js
@@ -58,7 +67,7 @@ import { searchClient } from '@algolia/client-search';
58
67
  const client = searchClient('YOUR_APP_ID', 'YOUR_API_KEY');
59
68
  ```
60
69
 
61
- For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.
70
+ For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/search/)**.
62
71
 
63
72
  ## ❓ Troubleshooting
64
73
 
package/dist/browser.d.ts CHANGED
@@ -2956,7 +2956,7 @@ type UpdatedRuleResponse = {
2956
2956
  taskID: number;
2957
2957
  };
2958
2958
 
2959
- declare const apiClientVersion = "5.6.0";
2959
+ declare const apiClientVersion = "5.7.0";
2960
2960
  declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
2961
2961
  transporter: _algolia_client_common.Transporter;
2962
2962
  /**
@@ -3385,7 +3385,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3385
3385
  */
3386
3386
  deleteSynonym({ indexName, objectID, forwardToReplicas }: DeleteSynonymProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
3387
3387
  /**
3388
- * 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.
3388
+ * 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>`.
3389
3389
  *
3390
3390
  * @param getApiKey - The getApiKey object.
3391
3391
  * @param getApiKey.key - API key.
package/dist/builds/browser.js CHANGED
@@ -19,7 +19,7 @@ import {
19
19
  ApiError,
20
20
  createIterablePromise
21
21
  } from "@algolia/client-common";
22
- var apiClientVersion = "5.6.0";
22
+ var apiClientVersion = "5.7.0";
23
23
  function getDefaultHosts(appId) {
24
24
  return [
25
25
  {
@@ -1153,7 +1153,7 @@ function createSearchClient({
1153
1153
  return transporter.request(request, requestOptions);
1154
1154
  },
1155
1155
  /**
1156
- * 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.
1156
+ * 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>`.
1157
1157
  *
1158
1158
  * @param getApiKey - The getApiKey object.
1159
1159
  * @param getApiKey.key - API key.