@algolia/client-search 5.23.2 → 5.23.4
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.
- package/README.md +4 -4
- package/dist/browser.d.ts +6 -6
- package/dist/builds/browser.js +3 -3
- package/dist/builds/browser.js.map +1 -1
- package/dist/builds/browser.min.js +1 -1
- package/dist/builds/browser.min.js.map +1 -1
- package/dist/builds/browser.umd.js +1 -1
- package/dist/builds/fetch.js +3 -3
- package/dist/builds/fetch.js.map +1 -1
- package/dist/builds/node.cjs +3 -3
- package/dist/builds/node.cjs.map +1 -1
- package/dist/builds/node.js +3 -3
- package/dist/builds/node.js.map +1 -1
- package/dist/builds/worker.js +3 -3
- package/dist/builds/worker.js.map +1 -1
- package/dist/fetch.d.ts +6 -6
- package/dist/node.d.cts +6 -6
- package/dist/node.d.ts +6 -6
- package/dist/src/searchClient.cjs +3 -3
- package/dist/src/searchClient.cjs.map +1 -1
- package/dist/src/searchClient.js +3 -3
- package/dist/src/searchClient.js.map +1 -1
- package/dist/worker.d.ts +6 -6
- package/package.json +9 -9
package/dist/worker.d.ts
CHANGED
|
@@ -358,7 +358,7 @@ type BaseSearchResponse = Record<string, any> & {
|
|
|
358
358
|
/**
|
|
359
359
|
* An object with custom data. You can store up to 32kB as custom data.
|
|
360
360
|
*/
|
|
361
|
-
userData?:
|
|
361
|
+
userData?: any | null;
|
|
362
362
|
/**
|
|
363
363
|
* Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
|
|
364
364
|
*/
|
|
@@ -999,7 +999,7 @@ type Condition = {
|
|
|
999
999
|
*/
|
|
1000
1000
|
context?: string;
|
|
1001
1001
|
/**
|
|
1002
|
-
* Filters that trigger the rule. You can add
|
|
1002
|
+
* Filters that trigger the rule. You can add filters using the syntax `facet:value` so that the rule is triggered, when the specific filter is selected. You can use `filters` on its own or combine it with the `pattern` parameter. You can\'t combine multiple filters with `OR` and you can\'t use numeric filters.
|
|
1003
1003
|
*/
|
|
1004
1004
|
filters?: string;
|
|
1005
1005
|
};
|
|
@@ -1969,7 +1969,7 @@ type BaseIndexSettings = {
|
|
|
1969
1969
|
/**
|
|
1970
1970
|
* An object with custom data. You can store up to 32kB as custom data.
|
|
1971
1971
|
*/
|
|
1972
|
-
userData?:
|
|
1972
|
+
userData?: any | null;
|
|
1973
1973
|
/**
|
|
1974
1974
|
* Characters and their normalized replacements. This overrides Algolia\'s default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).
|
|
1975
1975
|
*/
|
|
@@ -3028,7 +3028,7 @@ type ReplaceAllObjectsOptions = {
|
|
|
3028
3028
|
scopes?: Array<ScopeType>;
|
|
3029
3029
|
};
|
|
3030
3030
|
|
|
3031
|
-
declare const apiClientVersion = "5.23.
|
|
3031
|
+
declare const apiClientVersion = "5.23.4";
|
|
3032
3032
|
declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
|
|
3033
3033
|
transporter: _algolia_client_common.Transporter;
|
|
3034
3034
|
/**
|
|
@@ -3663,7 +3663,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
|
|
|
3663
3663
|
*/
|
|
3664
3664
|
operationIndex({ indexName, operationIndexParams }: OperationIndexProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
|
|
3665
3665
|
/**
|
|
3666
|
-
* Adds new attributes to a record, or updates existing ones. - If a record with the specified object ID doesn\'t exist, a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn\'t exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes. If you specify a nested attribute, this operation replaces its first-level ancestor. To update an attribute without pushing the entire record, you can use these built-in operations. These operations can be helpful if you don\'t have access to your initial data. - Increment: increment a numeric attribute - Decrement: decrement a numeric attribute - Add: append a number or string element to an array attribute - Remove: remove all matching number or string elements from an array attribute made of numbers or strings - AddUnique: add a number or string element to an array attribute made of numbers or strings only if it\'s not already present - IncrementFrom: increment a numeric integer attribute only if the provided value matches the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementFrom value of 2 for the version attribute, but the current value of the attribute is 1, the engine ignores the update. If the object doesn\'t exist, the engine only creates it if you pass an IncrementFrom value of 0. - IncrementSet: increment a numeric integer attribute only if the provided value is greater than the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementSet value of 2 for the version attribute, and the current value of the attribute is 1, the engine updates the object. If the object doesn\'t exist yet, the engine only creates it if you pass an IncrementSet value greater than 0. You can specify an operation by providing an object with the attribute to update as the key and its value being an object with the following properties: - _operation: the operation to apply on the attribute - value: the right-hand side argument to the operation, for example, increment or decrement step, value to add or remove. 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).
|
|
3666
|
+
* Adds new attributes to a record, or updates existing ones. - If a record with the specified object ID doesn\'t exist, a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn\'t exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes. If you specify a nested attribute, this operation replaces its first-level ancestor. To update an attribute without pushing the entire record, you can use these built-in operations. These operations can be helpful if you don\'t have access to your initial data. - Increment: increment a numeric attribute - Decrement: decrement a numeric attribute - Add: append a number or string element to an array attribute - Remove: remove all matching number or string elements from an array attribute made of numbers or strings - AddUnique: add a number or string element to an array attribute made of numbers or strings only if it\'s not already present - IncrementFrom: increment a numeric integer attribute only if the provided value matches the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementFrom value of 2 for the version attribute, but the current value of the attribute is 1, the engine ignores the update. If the object doesn\'t exist, the engine only creates it if you pass an IncrementFrom value of 0. - IncrementSet: increment a numeric integer attribute only if the provided value is greater than the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementSet value of 2 for the version attribute, and the current value of the attribute is 1, the engine updates the object. If the object doesn\'t exist yet, the engine only creates it if you pass an IncrementSet value greater than 0. You can specify an operation by providing an object with the attribute to update as the key and its value being an object with the following properties: - _operation: the operation to apply on the attribute - value: the right-hand side argument to the operation, for example, increment or decrement step, value to add or remove. When updating multiple attributes or using multiple operations targeting the same record, you should use a single partial update for faster processing. 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).
|
|
3667
3667
|
*
|
|
3668
3668
|
* Required API Key ACLs:
|
|
3669
3669
|
* - addObject
|
|
@@ -3771,7 +3771,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
|
|
|
3771
3771
|
*/
|
|
3772
3772
|
saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms }: SaveSynonymsProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
|
|
3773
3773
|
/**
|
|
3774
|
-
* Sends multiple search requests to one or more indices. This can be useful in these cases: - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.
|
|
3774
|
+
* Sends multiple search requests to one or more indices. This can be useful in these cases: - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters. Use the helper `searchForHits` or `searchForFacets` to get the results in a more convenient format, if you already know the return type you want.
|
|
3775
3775
|
*
|
|
3776
3776
|
* Required API Key ACLs:
|
|
3777
3777
|
* - search
|
package/package.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"version": "5.23.
|
|
2
|
+
"version": "5.23.4",
|
|
3
3
|
"repository": {
|
|
4
4
|
"type": "git",
|
|
5
5
|
"url": "git+https://github.com/algolia/algoliasearch-client-javascript.git"
|
|
@@ -49,18 +49,18 @@
|
|
|
49
49
|
"index.d.ts"
|
|
50
50
|
],
|
|
51
51
|
"dependencies": {
|
|
52
|
-
"@algolia/client-common": "5.23.
|
|
53
|
-
"@algolia/requester-browser-xhr": "5.23.
|
|
54
|
-
"@algolia/requester-fetch": "5.23.
|
|
55
|
-
"@algolia/requester-node-http": "5.23.
|
|
52
|
+
"@algolia/client-common": "5.23.4",
|
|
53
|
+
"@algolia/requester-browser-xhr": "5.23.4",
|
|
54
|
+
"@algolia/requester-fetch": "5.23.4",
|
|
55
|
+
"@algolia/requester-node-http": "5.23.4"
|
|
56
56
|
},
|
|
57
57
|
"devDependencies": {
|
|
58
58
|
"@arethetypeswrong/cli": "0.17.4",
|
|
59
|
-
"@types/node": "22.
|
|
60
|
-
"publint": "0.3.
|
|
61
|
-
"rollup": "4.
|
|
59
|
+
"@types/node": "22.14.1",
|
|
60
|
+
"publint": "0.3.11",
|
|
61
|
+
"rollup": "4.39.0",
|
|
62
62
|
"tsup": "8.4.0",
|
|
63
|
-
"typescript": "5.8.
|
|
63
|
+
"typescript": "5.8.3"
|
|
64
64
|
},
|
|
65
65
|
"engines": {
|
|
66
66
|
"node": ">= 14.0.0"
|