@algolia/client-search 5.0.0-beta.1 → 5.0.0-beta.10
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/LICENSE +21 -0
- package/dist/builds/browser.d.ts +73 -68
- package/dist/builds/browser.d.ts.map +1 -1
- package/dist/builds/node.d.ts +73 -68
- package/dist/builds/node.d.ts.map +1 -1
- package/dist/client-search.cjs +137 -12
- package/dist/client-search.esm.browser.js +130 -28
- package/dist/client-search.esm.node.js +137 -12
- package/dist/client-search.umd.js +2 -2
- package/dist/model/baseIndexSettings.d.ts +2 -2
- package/dist/model/baseIndexSettings.d.ts.map +1 -1
- package/dist/model/baseSearchResponse.d.ts +2 -18
- package/dist/model/baseSearchResponse.d.ts.map +1 -1
- package/dist/model/browsePagination.d.ts +19 -0
- package/dist/model/browsePagination.d.ts.map +1 -0
- package/dist/model/browseResponse.d.ts +2 -1
- package/dist/model/browseResponse.d.ts.map +1 -1
- package/dist/model/clientMethodProps.d.ts +31 -23
- package/dist/model/clientMethodProps.d.ts.map +1 -1
- package/dist/model/facetFilters.d.ts +1 -2
- package/dist/model/facetFilters.d.ts.map +1 -1
- package/dist/model/fetchedIndex.d.ts +4 -0
- package/dist/model/fetchedIndex.d.ts.map +1 -1
- package/dist/model/index.d.ts +5 -2
- package/dist/model/index.d.ts.map +1 -1
- package/dist/model/numericFilters.d.ts +1 -2
- package/dist/model/numericFilters.d.ts.map +1 -1
- package/dist/model/optionalFilters.d.ts +1 -2
- package/dist/model/optionalFilters.d.ts.map +1 -1
- package/dist/model/rankingInfo.d.ts +3 -3
- package/dist/model/rankingInfo.d.ts.map +1 -1
- package/dist/model/reRankingApplyFilter.d.ts +1 -2
- package/dist/model/reRankingApplyFilter.d.ts.map +1 -1
- package/dist/model/redirect.d.ts +1 -1
- package/dist/model/redirectURL.d.ts +7 -0
- package/dist/model/redirectURL.d.ts.map +1 -0
- package/dist/model/renderingContent.d.ts +2 -0
- package/dist/model/renderingContent.d.ts.map +1 -1
- package/dist/model/replaceAllObjectsResponse.d.ts +11 -0
- package/dist/model/replaceAllObjectsResponse.d.ts.map +1 -0
- package/dist/model/searchForFacetValuesResponse.d.ts +1 -1
- package/dist/model/searchPagination.d.ts +19 -0
- package/dist/model/searchPagination.d.ts.map +1 -0
- package/dist/model/searchResponse.d.ts +2 -1
- package/dist/model/searchResponse.d.ts.map +1 -1
- package/dist/model/{securedAPIKeyRestrictions.d.ts → securedApiKeyRestrictions.d.ts} +2 -2
- package/dist/model/{securedAPIKeyRestrictions.d.ts.map → securedApiKeyRestrictions.d.ts.map} +1 -1
- package/dist/model/tagFilters.d.ts +1 -2
- package/dist/model/tagFilters.d.ts.map +1 -1
- package/dist/model/value.d.ts +4 -0
- package/dist/model/value.d.ts.map +1 -1
- package/dist/src/searchClient.d.ts +67 -12
- package/dist/src/searchClient.d.ts.map +1 -1
- package/model/baseIndexSettings.ts +2 -2
- package/model/baseSearchResponse.ts +2 -22
- package/model/browsePagination.ts +23 -0
- package/model/browseResponse.ts +2 -0
- package/model/clientMethodProps.ts +42 -26
- package/model/facetFilters.ts +1 -3
- package/model/fetchedIndex.ts +5 -0
- package/model/index.ts +5 -2
- package/model/numericFilters.ts +1 -3
- package/model/optionalFilters.ts +1 -3
- package/model/rankingInfo.ts +3 -3
- package/model/reRankingApplyFilter.ts +1 -3
- package/model/redirect.ts +1 -1
- package/model/{mixedSearchFilters.ts → redirectURL.ts} +6 -1
- package/model/renderingContent.ts +3 -0
- package/model/replaceAllObjectsResponse.ts +15 -0
- package/model/searchForFacetValuesResponse.ts +1 -1
- package/model/searchPagination.ts +23 -0
- package/model/searchResponse.ts +3 -1
- package/model/{securedAPIKeyRestrictions.ts → securedApiKeyRestrictions.ts} +1 -1
- package/model/tagFilters.ts +1 -3
- package/model/value.ts +5 -0
- package/package.json +11 -8
- package/dist/model/mixedSearchFilters.d.ts +0 -2
- package/dist/model/mixedSearchFilters.d.ts.map +0 -1
|
@@ -4,7 +4,7 @@ import type { ApiKey } from '../model/apiKey';
|
|
|
4
4
|
import type { BatchParams } from '../model/batchParams';
|
|
5
5
|
import type { BatchResponse } from '../model/batchResponse';
|
|
6
6
|
import type { BrowseResponse } from '../model/browseResponse';
|
|
7
|
-
import type { BrowseOptions, ChunkedBatchOptions, ReplaceAllObjectsOptions,
|
|
7
|
+
import type { BrowseOptions, ChunkedBatchOptions, DeleteObjectsOptions, PartialUpdateObjectsOptions, ReplaceAllObjectsOptions, SaveObjectsOptions, WaitForApiKeyOptions, WaitForAppTaskOptions, WaitForTaskOptions, AddOrUpdateObjectProps, AssignUserIdProps, BatchProps, BatchAssignUserIdsProps, BatchDictionaryEntriesProps, BrowseProps, ClearObjectsProps, ClearRulesProps, ClearSynonymsProps, CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, DeleteApiKeyProps, DeleteByProps, DeleteIndexProps, DeleteObjectProps, DeleteRuleProps, DeleteSourceProps, DeleteSynonymProps, GetApiKeyProps, GetAppTaskProps, GetLogsProps, GetObjectProps, GetRuleProps, GetSettingsProps, GetSynonymProps, GetTaskProps, GetUserIdProps, HasPendingMappingsProps, ListIndicesProps, ListUserIdsProps, OperationIndexProps, PartialUpdateObjectProps, RemoveUserIdProps, ReplaceSourcesProps, RestoreApiKeyProps, SaveObjectProps, SaveRuleProps, SaveRulesProps, SaveSynonymProps, SaveSynonymsProps, LegacySearchMethodProps, SearchDictionaryEntriesProps, SearchForFacetValuesProps, SearchRulesProps, SearchSingleIndexProps, SearchSynonymsProps, SetSettingsProps, UpdateApiKeyProps } from '../model/clientMethodProps';
|
|
8
8
|
import type { CreatedAtResponse } from '../model/createdAtResponse';
|
|
9
9
|
import type { DeleteApiKeyResponse } from '../model/deleteApiKeyResponse';
|
|
10
10
|
import type { DeleteSourceResponse } from '../model/deleteSourceResponse';
|
|
@@ -26,6 +26,7 @@ import type { ListIndicesResponse } from '../model/listIndicesResponse';
|
|
|
26
26
|
import type { ListUserIdsResponse } from '../model/listUserIdsResponse';
|
|
27
27
|
import type { MultipleBatchResponse } from '../model/multipleBatchResponse';
|
|
28
28
|
import type { RemoveUserIdResponse } from '../model/removeUserIdResponse';
|
|
29
|
+
import type { ReplaceAllObjectsResponse } from '../model/replaceAllObjectsResponse';
|
|
29
30
|
import type { ReplaceSourceResponse } from '../model/replaceSourceResponse';
|
|
30
31
|
import type { Rule } from '../model/rule';
|
|
31
32
|
import type { SaveObjectResponse } from '../model/saveObjectResponse';
|
|
@@ -46,7 +47,7 @@ import type { UpdatedAtResponse } from '../model/updatedAtResponse';
|
|
|
46
47
|
import type { UpdatedAtWithObjectIdResponse } from '../model/updatedAtWithObjectIdResponse';
|
|
47
48
|
import type { UpdatedRuleResponse } from '../model/updatedRuleResponse';
|
|
48
49
|
import type { UserId } from '../model/userId';
|
|
49
|
-
export declare const apiClientVersion = "5.0.0-beta.
|
|
50
|
+
export declare const apiClientVersion = "5.0.0-beta.10";
|
|
50
51
|
export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
|
|
51
52
|
transporter: import("@algolia/client-common").Transporter;
|
|
52
53
|
/**
|
|
@@ -80,6 +81,17 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
80
81
|
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
|
|
81
82
|
*/
|
|
82
83
|
waitForTask({ indexName, taskID, maxRetries, timeout, }: WaitForTaskOptions, requestOptions?: RequestOptions): Promise<GetTaskResponse>;
|
|
84
|
+
/**
|
|
85
|
+
* Helper: Wait for an application-level task to complete for a given `taskID`.
|
|
86
|
+
*
|
|
87
|
+
* @summary Helper method that waits for a task to be published (completed).
|
|
88
|
+
* @param waitForAppTaskOptions - The `waitForTaskOptions` object.
|
|
89
|
+
* @param waitForAppTaskOptions.taskID - The `taskID` returned in the method response.
|
|
90
|
+
* @param waitForAppTaskOptions.maxRetries - The maximum number of retries. 50 by default.
|
|
91
|
+
* @param waitForAppTaskOptions.timeout - The function to decide how long to wait between retries.
|
|
92
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
|
|
93
|
+
*/
|
|
94
|
+
waitForAppTask({ taskID, maxRetries, timeout, }: WaitForAppTaskOptions, requestOptions?: RequestOptions): Promise<GetTaskResponse>;
|
|
83
95
|
/**
|
|
84
96
|
* Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
|
|
85
97
|
*
|
|
@@ -137,8 +149,8 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
137
149
|
* @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
|
|
138
150
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
139
151
|
*/
|
|
140
|
-
searchForHits<
|
|
141
|
-
results: SearchResponse<
|
|
152
|
+
searchForHits<T>(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: RequestOptions): Promise<{
|
|
153
|
+
results: Array<SearchResponse<T>>;
|
|
142
154
|
}>;
|
|
143
155
|
/**
|
|
144
156
|
* Helper: calls the `search` method but with certainty that we will only request Algolia facets and not records (hits).
|
|
@@ -164,15 +176,47 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
164
176
|
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
|
|
165
177
|
*/
|
|
166
178
|
chunkedBatch({ indexName, objects, action, waitForTasks, batchSize, }: ChunkedBatchOptions, requestOptions?: RequestOptions): Promise<BatchResponse[]>;
|
|
179
|
+
/**
|
|
180
|
+
* Helper: Saves the given array of objects in the given index. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objects in it.
|
|
181
|
+
*
|
|
182
|
+
* @summary Helper: Saves the given array of objects in the given index. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objects in it.
|
|
183
|
+
* @param saveObjects - The `saveObjects` object.
|
|
184
|
+
* @param saveObjects.indexName - The `indexName` to save `objects` in.
|
|
185
|
+
* @param saveObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
|
|
186
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
|
|
187
|
+
*/
|
|
188
|
+
saveObjects({ indexName, objects }: SaveObjectsOptions, requestOptions?: RequestOptions): Promise<BatchResponse[]>;
|
|
189
|
+
/**
|
|
190
|
+
* Helper: Deletes every records for the given objectIDs. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objectIDs in it.
|
|
191
|
+
*
|
|
192
|
+
* @summary Helper: Deletes every records for the given objectIDs. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objectIDs in it.
|
|
193
|
+
* @param deleteObjects - The `deleteObjects` object.
|
|
194
|
+
* @param deleteObjects.indexName - The `indexName` to delete `objectIDs` from.
|
|
195
|
+
* @param deleteObjects.objectIDs - The objectIDs to delete.
|
|
196
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
|
|
197
|
+
*/
|
|
198
|
+
deleteObjects({ indexName, objectIDs }: DeleteObjectsOptions, requestOptions?: RequestOptions): Promise<BatchResponse[]>;
|
|
199
|
+
/**
|
|
200
|
+
* Helper: Replaces object content of all the given objects according to their respective `objectID` field. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objects in it.
|
|
201
|
+
*
|
|
202
|
+
* @summary Helper: Replaces object content of all the given objects according to their respective `objectID` field. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objects in it.
|
|
203
|
+
* @param partialUpdateObjects - The `partialUpdateObjects` object.
|
|
204
|
+
* @param partialUpdateObjects.indexName - The `indexName` to update `objects` in.
|
|
205
|
+
* @param partialUpdateObjects.objects - The array of `objects` to update in the given Algolia `indexName`.
|
|
206
|
+
* @param partialUpdateObjects.createIfNotExists - To be provided if non-existing objects are passed, otherwise, the call will fail..
|
|
207
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
|
|
208
|
+
*/
|
|
209
|
+
partialUpdateObjects({ indexName, objects, createIfNotExists }: PartialUpdateObjectsOptions, requestOptions?: RequestOptions): Promise<BatchResponse[]>;
|
|
167
210
|
/**
|
|
168
211
|
* Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
|
|
212
|
+
* See https://api-clients-automation.netlify.app/docs/contributing/add-new-api-client#5-helpers for implementation details.
|
|
169
213
|
*
|
|
170
214
|
* @summary Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
|
|
171
215
|
* @param replaceAllObjects - The `replaceAllObjects` object.
|
|
172
216
|
* @param replaceAllObjects.indexName - The `indexName` to replace `objects` in.
|
|
173
217
|
* @param replaceAllObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
|
|
174
|
-
* @param replaceAllObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length
|
|
175
|
-
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
|
|
218
|
+
* @param replaceAllObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `objects.length / batchSize`. Defaults to 1000.
|
|
219
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch`, `operationIndex` and `getTask` method and merged with the transporter requestOptions.
|
|
176
220
|
*/
|
|
177
221
|
replaceAllObjects({ indexName, objects, batchSize }: ReplaceAllObjectsOptions, requestOptions?: RequestOptions): Promise<ReplaceAllObjectsResponse>;
|
|
178
222
|
/**
|
|
@@ -254,7 +298,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
254
298
|
*/
|
|
255
299
|
batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams, }: BatchDictionaryEntriesProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
|
|
256
300
|
/**
|
|
257
|
-
* Retrieves records from an index, up to 1,000 per request. While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices. - The Analytics API doesn\'t collect data when using `browse`. - Records are ranked by attributes and custom ranking. -
|
|
301
|
+
* Retrieves records from an index, up to 1,000 per request. While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices. - The Analytics API doesn\'t collect data when using `browse`. - Records are ranked by attributes and custom ranking. - There\'s no ranking for: typo-tolerance, number of matched words, proximity, geo distance. Browse requests automatically apply these settings: - `advancedSyntax`: `false` - `attributesToHighlight`: `[]` - `attributesToSnippet`: `[]` - `distinct`: `false` - `enablePersonalization`: `false` - `enableRules`: `false` - `facets`: `[]` - `getRankingInfo`: `false` - `ignorePlurals`: `false` - `optionalFilters`: `[]` - `typoTolerance`: `true` or `false` (`min` and `strict` is evaluated to `true`) If you send these parameters with your browse requests, they\'ll be ignored.
|
|
258
302
|
*
|
|
259
303
|
* Required API Key ACLs:
|
|
260
304
|
* - browse.
|
|
@@ -264,7 +308,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
264
308
|
* @param browse.browseParams - The browseParams object.
|
|
265
309
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
266
310
|
*/
|
|
267
|
-
browse<
|
|
311
|
+
browse<T>({ indexName, browseParams }: BrowseProps, requestOptions?: RequestOptions): Promise<BrowseResponse<T>>;
|
|
268
312
|
/**
|
|
269
313
|
* Deletes only the records from an index while keeping settings, synonyms, and rules.
|
|
270
314
|
*
|
|
@@ -429,6 +473,17 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
429
473
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
430
474
|
*/
|
|
431
475
|
getApiKey({ key }: GetApiKeyProps, requestOptions?: RequestOptions): Promise<GetApiKeyResponse>;
|
|
476
|
+
/**
|
|
477
|
+
* Checks the status of a given application task.
|
|
478
|
+
*
|
|
479
|
+
* Required API Key ACLs:
|
|
480
|
+
* - editSettings.
|
|
481
|
+
*
|
|
482
|
+
* @param getAppTask - The getAppTask object.
|
|
483
|
+
* @param getAppTask.taskID - Unique task identifier.
|
|
484
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
485
|
+
*/
|
|
486
|
+
getAppTask({ taskID }: GetAppTaskProps, requestOptions?: RequestOptions): Promise<GetTaskResponse>;
|
|
432
487
|
/**
|
|
433
488
|
* Lists supported languages with their supported dictionary types and number of custom entries.
|
|
434
489
|
*
|
|
@@ -483,7 +538,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
483
538
|
* @param getObjectsParams - Request object.
|
|
484
539
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
485
540
|
*/
|
|
486
|
-
getObjects<
|
|
541
|
+
getObjects<T>(getObjectsParams: GetObjectsParams, requestOptions?: RequestOptions): Promise<GetObjectsResponse<T>>;
|
|
487
542
|
/**
|
|
488
543
|
* Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](#tag/Rules/operation/searchRules).
|
|
489
544
|
*
|
|
@@ -621,7 +676,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
621
676
|
*/
|
|
622
677
|
multipleBatch(batchParams: BatchParams, requestOptions?: RequestOptions): Promise<MultipleBatchResponse>;
|
|
623
678
|
/**
|
|
624
|
-
* Copies or moves (renames) an index within the same Algolia application. - Existing destination indices are overwritten, except for
|
|
679
|
+
* Copies or moves (renames) an index within the same Algolia application. - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn\'t exist yet, it\'ll be created. **Copy** - Copying a source index that doesn\'t exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can\'t copy the `enableReRanking`, `mode`, and `replicas` settings. - You can\'t copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/) **Move** - Moving a source index that doesn\'t exist is ignored without returning an error. - When moving an index, the analytics data keep their original name and a new set of analytics data is started for the new name. To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices/).
|
|
625
680
|
*
|
|
626
681
|
* Required API Key ACLs:
|
|
627
682
|
* - addObject.
|
|
@@ -756,7 +811,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
756
811
|
* @param searchMethodParams - Muli-search request body. Results are returned in the same order as the requests.
|
|
757
812
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
758
813
|
*/
|
|
759
|
-
search<
|
|
814
|
+
search<T>(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: RequestOptions): Promise<SearchResponses<T>>;
|
|
760
815
|
/**
|
|
761
816
|
* Searches for standard and custom dictionary entries.
|
|
762
817
|
*
|
|
@@ -805,7 +860,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
805
860
|
* @param searchSingleIndex.searchParams - The searchParams object.
|
|
806
861
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
807
862
|
*/
|
|
808
|
-
searchSingleIndex<
|
|
863
|
+
searchSingleIndex<T>({ indexName, searchParams }: SearchSingleIndexProps, requestOptions?: RequestOptions): Promise<SearchResponse<T>>;
|
|
809
864
|
/**
|
|
810
865
|
* Searches for synonyms in your index.
|
|
811
866
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"searchClient.d.ts","sourceRoot":"","sources":["../../src/searchClient.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EACV,mBAAmB,EAKnB,cAAc,EACd,QAAQ,EAET,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAExD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EACV,aAAa,EACb,mBAAmB,EACnB,wBAAwB,EACxB,
|
|
1
|
+
{"version":3,"file":"searchClient.d.ts","sourceRoot":"","sources":["../../src/searchClient.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EACV,mBAAmB,EAKnB,cAAc,EACd,QAAQ,EAET,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAExD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EACV,aAAa,EACb,mBAAmB,EACnB,oBAAoB,EACpB,2BAA2B,EAC3B,wBAAwB,EACxB,kBAAkB,EAClB,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,sBAAsB,EACtB,iBAAiB,EACjB,UAAU,EACV,uBAAuB,EACvB,2BAA2B,EAC3B,WAAW,EACX,iBAAiB,EACjB,eAAe,EACf,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,cAAc,EACd,eAAe,EACf,YAAY,EACZ,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,eAAe,EACf,YAAY,EACZ,cAAc,EACd,uBAAuB,EACvB,gBAAgB,EAChB,gBAAgB,EAChB,mBAAmB,EACnB,wBAAwB,EACxB,iBAAiB,EACjB,mBAAmB,EACnB,kBAAkB,EAClB,eAAe,EACf,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,uBAAuB,EACvB,4BAA4B,EAC5B,yBAAyB,EACzB,gBAAgB,EAChB,sBAAsB,EACtB,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAC5F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAC;AACtF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AACpF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,0CAA0C,CAAC;AAChG,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAC1F,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAC9E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAC5F,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAE9C,eAAO,MAAM,gBAAgB,kBAAkB,CAAC;AAsChD,wBAAgB,kBAAkB,CAAC,EACjC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,GAAG,OAAO,EACX,EAAE,mBAAmB;;IAwBlB;;OAEG;;IAGH;;OAEG;kBACW,OAAO,CAAC,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;;;OAUG;6DAQE,kBAAkB,mBACJ,cAAc,GAC9B,OAAO,CAAC,eAAe,CAAC;IAgB3B;;;;;;;;;OASG;qDAOE,qBAAqB,mBACP,cAAc,GAC9B,OAAO,CAAC,eAAe,CAAC;IAgB3B;;;;;;;;;;;OAWG;oEASE,oBAAoB,mBACN,cAAc,GAC9B,OAAO,CAAC,QAAQ,GAAG,iBAAiB,CAAC;IAoDxC;;;;;;;;;;OAUG;kBACW,CAAC,wDAKV,aAAa,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,mBAChC,cAAc,GAC9B,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAmB7B;;;;;;;;;;OAUG;yEAME,aAAa,CAAC,mBAAmB,CAAC,GAAG,gBAAgB,mBACvC,cAAc,GAC9B,OAAO,CAAC,mBAAmB,CAAC;IA0B/B;;;;;;;;;;OAUG;kFAME,aAAa,CAAC,sBAAsB,CAAC,GAAG,mBAAmB,mBAC7C,cAAc,GAC9B,OAAO,CAAC,sBAAsB,CAAC;IA2BlC;;;;;;;OAOG;kBACW,CAAC,sBACO,uBAAuB,GAAG,kBAAkB,mBAC/C,cAAc,GAC9B,OAAO,CAAC;QAAE,OAAO,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAA;KAAE,CAAC;IAMjD;;;;;;;OAOG;wCAEmB,uBAAuB,GAAG,kBAAkB,mBAC/C,cAAc,GAC9B,OAAO,CAAC;QAAE,OAAO,EAAE,4BAA4B,EAAE,CAAA;KAAE,CAAC;IAMvD;;;;;;;;;;;OAWG;2EAQE,mBAAmB,mBACL,cAAc,GAC9B,OAAO,CAAC,aAAa,EAAE,CAAC;IA2B3B;;;;;;;;OAQG;wCAEuB,kBAAkB,mBACzB,cAAc,GAC9B,OAAO,CAAC,aAAa,EAAE,CAAC;IAO3B;;;;;;;;OAQG;4CAEyB,oBAAoB,mBAC7B,cAAc,GAC9B,OAAO,CAAC,aAAa,EAAE,CAAC;IAW3B;;;;;;;;;OASG;oEAE0C,2BAA2B,mBACrD,cAAc,GAC9B,OAAO,CAAC,aAAa,EAAE,CAAC;IAa3B;;;;;;;;;;OAUG;yDAEkC,wBAAwB,mBAC1C,cAAc,GAC9B,OAAO,CAAC,yBAAyB,CAAC;IAwDrC;;;;;;;;OAQG;sBAEO,MAAM,mBACG,cAAc,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IA4B7B;;;;;;;;;;;OAWG;qDAE8B,sBAAsB,mBACpC,cAAc,GAC9B,OAAO,CAAC,6BAA6B,CAAC;IAoCzC;;;;;;;;OAQG;yBAEO,MAAM,mBACG,cAAc,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IA4B7B;;;;;;;;;;OAUG;yDAEuC,iBAAiB,mBACxC,cAAc,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IAsC7B;;;;;;;OAOG;2CAEgC,UAAU,mBAC1B,cAAc,GAC9B,OAAO,CAAC,aAAa,CAAC;IAqCzB;;;;;;;;;;OAUG;qEAE6C,uBAAuB,mBACpD,cAAc,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IA2C7B;;;;;;;;;;OAUG;8EAKE,2BAA2B,mBACb,cAAc,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IAqC7B;;;;;;;;;;OAUG;WACI,CAAC,+BACuB,WAAW,mBACvB,cAAc,GAC9B,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAyB7B;;;;;;;;;OASG;gCAEc,iBAAiB,mBACf,cAAc,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IAwB7B;;;;;;;;;;OAUG;iDAEiC,eAAe,mBAChC,cAAc,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IA4B7B;;;;;;;;;;OAUG;oDAEiC,kBAAkB,mBACnC,cAAc,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IA4B7B;;;;;;;OAOG;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;OAOG;oCAEqB,cAAc,mBACnB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;OAQG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;OAQG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;;OASG;0BAEQ,iBAAiB,mBACT,cAAc,GAC9B,OAAO,CAAC,oBAAoB,CAAC;IAwBhC;;;;;;;;;;OAUG;4CAE8B,aAAa,mBAC3B,cAAc,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IA+B7B;;;;;;;;;OASG;+BAEc,gBAAgB,mBACd,cAAc,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IAwB7B;;;;;;;;;;OAUG;0CAEwB,iBAAiB,mBACzB,cAAc,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IA6B7B;;;;;;;;;;;OAWG;2DAE2C,eAAe,mBAC1C,cAAc,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IAiC7B;;;;;;;;;OASG;6BAEW,iBAAiB,mBACZ,cAAc,GAC9B,OAAO,CAAC,oBAAoB,CAAC;IAwBhC;;;;;;;;;;;OAWG;8DAE2C,kBAAkB,mBAC7C,cAAc,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IAiC7B;;;;;;OAMG;uBAEQ,cAAc,mBACN,cAAc,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IAwB7B;;;;;;;;;OASG;2BAEW,eAAe,mBACV,cAAc,GAC9B,OAAO,CAAC,eAAe,CAAC;IAwB3B;;;;;;;OAOG;4CAEgB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAerC;;;;;;;OAOG;2CAEgB,cAAc,GAC9B,OAAO,CAAC,6BAA6B,CAAC;IAezC;;;;;;;;;;;;OAYG;kDAEoC,YAAY,mBACjC,cAAc,GAAG,SAAS,GACzC,OAAO,CAAC,eAAe,CAAC;IA+B3B;;;;;;;;;;;OAWG;6DAE8C,cAAc,mBAC5C,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAiClC;;;;;;;;OAQG;eACQ,CAAC,oBACQ,gBAAgB,mBACjB,cAAc,GAC9B,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;IA8BjC;;;;;;;;;;OAUG;qCAEwB,YAAY,mBACpB,cAAc,GAC9B,OAAO,CAAC,IAAI,CAAC;IA6BhB;;;;;;;;;OASG;+BAEc,gBAAgB,mBACd,cAAc,GAC9B,OAAO,CAAC,aAAa,CAAC;IAwBzB;;;;;;;OAOG;gCACyB,cAAc,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAe9D;;;;;;;;;;OAUG;wCAEwB,eAAe,mBACvB,cAAc,GAC9B,OAAO,CAAC,UAAU,CAAC;IA6BtB;;;;;;;;;;OAUG;mCAEsB,YAAY,mBAClB,cAAc,GAC9B,OAAO,CAAC,eAAe,CAAC;IA6B3B;;;;;;;OAOG;mCAEgB,cAAc,GAC9B,OAAO,CAAC,qBAAqB,CAAC;IAejC;;;;;;;;;OASG;0BAEW,cAAc,mBACT,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC;IAwBlB;;;;;;;;;OASG;yCAEgB,uBAAuB,mBACxB,cAAc,GAAG,SAAS,GACzC,OAAO,CAAC,0BAA0B,CAAC;IAmBtC;;;;;;;OAOG;iCAC0B,cAAc,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAe1E;;;;;;;OAOG;kCAEgB,cAAc,GAC9B,OAAO,CAAC,oBAAoB,CAAC;IAehC;;;;;;;;;;OAUG;wCAEsB,gBAAgB,mBACvB,cAAc,GAAG,SAAS,GACzC,OAAO,CAAC,mBAAmB,CAAC;IAuB/B;;;;;;;;;;OAUG;wCAEsB,gBAAgB,mBACvB,cAAc,GAAG,SAAS,GACzC,OAAO,CAAC,mBAAmB,CAAC;IAuB/B;;;;;OAKG;+BAEY,WAAW,mBACP,cAAc,GAC9B,OAAO,CAAC,qBAAqB,CAAC;IA4BjC;;;;;;;;;;OAUG;wDAEoC,mBAAmB,mBACvC,cAAc,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IA0C7B;;;;;;;;;;;;OAYG;yFAOE,wBAAwB,mBACV,cAAc,GAC9B,OAAO,CAAC,6BAA6B,CAAC;IAwCzC;;;;;;;;;OASG;6BAEW,iBAAiB,mBACZ,cAAc,GAC9B,OAAO,CAAC,oBAAoB,CAAC;IAwBhC;;;;;;;;;OASG;+BAEW,mBAAmB,mBACd,cAAc,GAC9B,OAAO,CAAC,qBAAqB,CAAC;IAsBjC;;;;;;;;;OASG;2BAEQ,kBAAkB,mBACV,cAAc,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IAwB7B;;;;;;;;;;OAUG;oCAEoB,eAAe,mBACnB,cAAc,GAC9B,OAAO,CAAC,kBAAkB,CAAC;IA+B9B;;;;;;;;;;;;OAYG;+DAEiD,aAAa,mBAC9C,cAAc,GAC9B,OAAO,CAAC,mBAAmB,CAAC;IA8C/B;;;;;;;;;;;;OAYG;4EAOE,cAAc,mBACA,cAAc,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IAuC7B;;;;;;;;;;;;OAYG;wEAEuD,gBAAgB,mBACvD,cAAc,GAC9B,OAAO,CAAC,mBAAmB,CAAC;IAmD/B;;;;;;;;;;;;OAYG;yFAOE,iBAAiB,mBACH,cAAc,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IAwC7B;;;;;;;;OAQG;WACI,CAAC,sBACc,uBAAuB,GAAG,kBAAkB,mBAC/C,cAAc,GAC9B,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IAuD9B;;;;;;;;;;OAUG;gFAKE,4BAA4B,mBACd,cAAc,GAC9B,OAAO,CAAC,+BAA+B,CAAC;IAuC3C;;;;;;;;;;;OAWG;iFAME,yBAAyB,mBACX,cAAc,GAC9B,OAAO,CAAC,4BAA4B,CAAC;IAgCxC;;;;;;;;;;OAUG;kDAEiC,gBAAgB,mBACjC,cAAc,GAC9B,OAAO,CAAC,mBAAmB,CAAC;IA2B/B;;;;;;;;;;OAUG;sBACe,CAAC,+BACY,sBAAsB,mBAClC,cAAc,GAC9B,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IA2B7B;;;;;;;;;;OAUG;wDAEoC,mBAAmB,mBACvC,cAAc,GAC9B,OAAO,CAAC,sBAAsB,CAAC;IA2BlC;;;;;;;;OAQG;uCAEoB,mBAAmB,mBACvB,cAAc,GAC9B,OAAO,CAAC,qBAAqB,CAAC;IA8BjC;;;;;;;;OAQG;oDAEyB,wBAAwB,mBACjC,cAAc,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IA4B7B;;;;;;;;;;;OAWG;iEAEgD,gBAAgB,mBAChD,cAAc,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IAmC7B;;;;;;;;;;OAUG;kCAEgB,iBAAiB,mBACjB,cAAc,GAC9B,OAAO,CAAC,oBAAoB,CAAC;EAqCnC"}
|
|
@@ -74,9 +74,9 @@ export type BaseIndexSettings = {
|
|
|
74
74
|
searchableAttributes?: string[];
|
|
75
75
|
|
|
76
76
|
/**
|
|
77
|
-
* An object with custom data. You can store up to
|
|
77
|
+
* An object with custom data. You can store up to 32kB as custom data.
|
|
78
78
|
*/
|
|
79
|
-
userData?: any
|
|
79
|
+
userData?: Record<string, any>;
|
|
80
80
|
|
|
81
81
|
/**
|
|
82
82
|
* 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/).
|
|
@@ -53,11 +53,6 @@ export type BaseSearchResponse = Record<string, any> & {
|
|
|
53
53
|
*/
|
|
54
54
|
facets_stats?: Record<string, FacetsStats>;
|
|
55
55
|
|
|
56
|
-
/**
|
|
57
|
-
* Number of hits per page.
|
|
58
|
-
*/
|
|
59
|
-
hitsPerPage: number;
|
|
60
|
-
|
|
61
56
|
/**
|
|
62
57
|
* Index name used for the query.
|
|
63
58
|
*/
|
|
@@ -73,26 +68,11 @@ export type BaseSearchResponse = Record<string, any> & {
|
|
|
73
68
|
*/
|
|
74
69
|
message?: string;
|
|
75
70
|
|
|
76
|
-
/**
|
|
77
|
-
* Number of results (hits).
|
|
78
|
-
*/
|
|
79
|
-
nbHits: number;
|
|
80
|
-
|
|
81
|
-
/**
|
|
82
|
-
* Number of pages of results.
|
|
83
|
-
*/
|
|
84
|
-
nbPages: number;
|
|
85
|
-
|
|
86
71
|
/**
|
|
87
72
|
* Number of hits selected and sorted by the relevant sort algorithm.
|
|
88
73
|
*/
|
|
89
74
|
nbSortedHits?: number;
|
|
90
75
|
|
|
91
|
-
/**
|
|
92
|
-
* Page of search results to retrieve.
|
|
93
|
-
*/
|
|
94
|
-
page: number;
|
|
95
|
-
|
|
96
76
|
/**
|
|
97
77
|
* Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.
|
|
98
78
|
*/
|
|
@@ -128,9 +108,9 @@ export type BaseSearchResponse = Record<string, any> & {
|
|
|
128
108
|
serverUsed?: string;
|
|
129
109
|
|
|
130
110
|
/**
|
|
131
|
-
* An object with custom data. You can store up to
|
|
111
|
+
* An object with custom data. You can store up to 32kB as custom data.
|
|
132
112
|
*/
|
|
133
|
-
userData?: any
|
|
113
|
+
userData?: Record<string, any>;
|
|
134
114
|
|
|
135
115
|
/**
|
|
136
116
|
* Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
export type BrowsePagination = {
|
|
4
|
+
/**
|
|
5
|
+
* Page of search results to retrieve.
|
|
6
|
+
*/
|
|
7
|
+
page?: number;
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* Number of results (hits).
|
|
11
|
+
*/
|
|
12
|
+
nbHits?: number;
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* Number of pages of results.
|
|
16
|
+
*/
|
|
17
|
+
nbPages?: number;
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
* Number of hits per page.
|
|
21
|
+
*/
|
|
22
|
+
hitsPerPage?: number;
|
|
23
|
+
};
|
package/model/browseResponse.ts
CHANGED
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
3
|
import type { BaseSearchResponse } from './baseSearchResponse';
|
|
4
|
+
import type { BrowsePagination } from './browsePagination';
|
|
4
5
|
import type { Cursor } from './cursor';
|
|
5
6
|
import type { SearchHits } from './searchHits';
|
|
6
7
|
|
|
7
8
|
export type BrowseResponse<T = Record<string, any>> = BaseSearchResponse &
|
|
9
|
+
BrowsePagination &
|
|
8
10
|
Cursor &
|
|
9
11
|
SearchHits<T>;
|
|
@@ -9,7 +9,6 @@ import type { AssignUserIdParams } from './assignUserIdParams';
|
|
|
9
9
|
import type { AttributeToUpdate } from './attributeToUpdate';
|
|
10
10
|
import type { BatchAssignUserIdsParams } from './batchAssignUserIdsParams';
|
|
11
11
|
import type { BatchDictionaryEntriesParams } from './batchDictionaryEntriesParams';
|
|
12
|
-
import type { BatchResponse } from './batchResponse';
|
|
13
12
|
import type { BatchWriteParams } from './batchWriteParams';
|
|
14
13
|
import type { BrowseParams } from './browseParams';
|
|
15
14
|
import type { DeleteByParams } from './deleteByParams';
|
|
@@ -26,10 +25,9 @@ import type { SearchParams } from './searchParams';
|
|
|
26
25
|
import type { SearchParamsObject } from './searchParamsObject';
|
|
27
26
|
import type { SearchRulesParams } from './searchRulesParams';
|
|
28
27
|
import type { SearchSynonymsParams } from './searchSynonymsParams';
|
|
29
|
-
import type {
|
|
28
|
+
import type { SecuredApiKeyRestrictions } from './securedApiKeyRestrictions';
|
|
30
29
|
import type { Source } from './source';
|
|
31
30
|
import type { SynonymHit } from './synonymHit';
|
|
32
|
-
import type { UpdatedAtResponse } from './updatedAtResponse';
|
|
33
31
|
|
|
34
32
|
/**
|
|
35
33
|
* Properties for the `addOrUpdateObject` method.
|
|
@@ -307,6 +305,16 @@ export type GetApiKeyProps = {
|
|
|
307
305
|
key: string;
|
|
308
306
|
};
|
|
309
307
|
|
|
308
|
+
/**
|
|
309
|
+
* Properties for the `getAppTask` method.
|
|
310
|
+
*/
|
|
311
|
+
export type GetAppTaskProps = {
|
|
312
|
+
/**
|
|
313
|
+
* Unique task identifier.
|
|
314
|
+
*/
|
|
315
|
+
taskID: number;
|
|
316
|
+
};
|
|
317
|
+
|
|
310
318
|
/**
|
|
311
319
|
* Properties for the `getLogs` method.
|
|
312
320
|
*/
|
|
@@ -740,17 +748,20 @@ type WaitForOptions = Partial<{
|
|
|
740
748
|
timeout: (retryCount: number) => number;
|
|
741
749
|
}>;
|
|
742
750
|
|
|
743
|
-
export type
|
|
744
|
-
/**
|
|
745
|
-
* The `indexName` where the operation was performed.
|
|
746
|
-
*/
|
|
747
|
-
indexName: string;
|
|
751
|
+
export type WaitForAppTaskOptions = WaitForOptions & {
|
|
748
752
|
/**
|
|
749
753
|
* The `taskID` returned by the method response.
|
|
750
754
|
*/
|
|
751
755
|
taskID: number;
|
|
752
756
|
};
|
|
753
757
|
|
|
758
|
+
export type WaitForTaskOptions = WaitForAppTaskOptions & {
|
|
759
|
+
/**
|
|
760
|
+
* The `indexName` where the operation was performed.
|
|
761
|
+
*/
|
|
762
|
+
indexName: string;
|
|
763
|
+
};
|
|
764
|
+
|
|
754
765
|
export type WaitForApiKeyOptions = WaitForOptions & {
|
|
755
766
|
/**
|
|
756
767
|
* The API Key.
|
|
@@ -785,7 +796,7 @@ export type GenerateSecuredApiKeyOptions = {
|
|
|
785
796
|
/**
|
|
786
797
|
* A set of properties defining the restrictions of the secured API key.
|
|
787
798
|
*/
|
|
788
|
-
restrictions?:
|
|
799
|
+
restrictions?: SecuredApiKeyRestrictions;
|
|
789
800
|
};
|
|
790
801
|
|
|
791
802
|
export type GetSecuredApiKeyRemainingValidityOptions = {
|
|
@@ -795,6 +806,28 @@ export type GetSecuredApiKeyRemainingValidityOptions = {
|
|
|
795
806
|
securedApiKey: string;
|
|
796
807
|
};
|
|
797
808
|
|
|
809
|
+
export type DeleteObjectsOptions = Pick<ChunkedBatchOptions, 'indexName'> & {
|
|
810
|
+
/**
|
|
811
|
+
* The objectIDs to delete.
|
|
812
|
+
*/
|
|
813
|
+
objectIDs: string[];
|
|
814
|
+
};
|
|
815
|
+
|
|
816
|
+
export type PartialUpdateObjectsOptions = Pick<
|
|
817
|
+
ChunkedBatchOptions,
|
|
818
|
+
'indexName' | 'objects'
|
|
819
|
+
> & {
|
|
820
|
+
/**
|
|
821
|
+
*To be provided if non-existing objects are passed, otherwise, the call will fail.
|
|
822
|
+
*/
|
|
823
|
+
createIfNotExists?: boolean;
|
|
824
|
+
};
|
|
825
|
+
|
|
826
|
+
export type SaveObjectsOptions = Pick<
|
|
827
|
+
ChunkedBatchOptions,
|
|
828
|
+
'indexName' | 'objects'
|
|
829
|
+
>;
|
|
830
|
+
|
|
798
831
|
export type ChunkedBatchOptions = ReplaceAllObjectsOptions & {
|
|
799
832
|
/**
|
|
800
833
|
* The `batch` `action` to perform on the given array of `objects`, defaults to `addObject`.
|
|
@@ -823,20 +856,3 @@ export type ReplaceAllObjectsOptions = {
|
|
|
823
856
|
*/
|
|
824
857
|
batchSize?: number;
|
|
825
858
|
};
|
|
826
|
-
|
|
827
|
-
export type ReplaceAllObjectsResponse = {
|
|
828
|
-
/**
|
|
829
|
-
* The response of the `operationIndex` request for the `copy` operation.
|
|
830
|
-
*/
|
|
831
|
-
copyOperationResponse: UpdatedAtResponse;
|
|
832
|
-
|
|
833
|
-
/**
|
|
834
|
-
* The response of the `batch` request(s).
|
|
835
|
-
*/
|
|
836
|
-
batchResponses: BatchResponse[];
|
|
837
|
-
|
|
838
|
-
/**
|
|
839
|
-
* The response of the `operationIndex` request for the `move` operation.
|
|
840
|
-
*/
|
|
841
|
-
moveOperationResponse: UpdatedAtResponse;
|
|
842
|
-
};
|
package/model/facetFilters.ts
CHANGED
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
|
-
import type { MixedSearchFilters } from './mixedSearchFilters';
|
|
4
|
-
|
|
5
3
|
/**
|
|
6
4
|
* Filter the search by facet values, so that only records with the same facet values are retrieved. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`. While it\'s best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`.
|
|
7
5
|
*/
|
|
8
|
-
export type FacetFilters =
|
|
6
|
+
export type FacetFilters = FacetFilters[] | string;
|
package/model/fetchedIndex.ts
CHANGED
|
@@ -55,4 +55,9 @@ export type FetchedIndex = {
|
|
|
55
55
|
* Only present if the index is a primary index with replicas. Contains the names of all linked replicas.
|
|
56
56
|
*/
|
|
57
57
|
replicas?: string[];
|
|
58
|
+
|
|
59
|
+
/**
|
|
60
|
+
* Only present if the index is a [virtual replica](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-an-index-alphabetically/#virtual-replicas).
|
|
61
|
+
*/
|
|
62
|
+
virtual?: boolean;
|
|
58
63
|
};
|
package/model/index.ts
CHANGED
|
@@ -28,6 +28,7 @@ export * from './batchParams';
|
|
|
28
28
|
export * from './batchRequest';
|
|
29
29
|
export * from './batchResponse';
|
|
30
30
|
export * from './batchWriteParams';
|
|
31
|
+
export * from './browsePagination';
|
|
31
32
|
export * from './browseParams';
|
|
32
33
|
export * from './browseParamsObject';
|
|
33
34
|
export * from './browseResponse';
|
|
@@ -88,7 +89,6 @@ export * from './logQuery';
|
|
|
88
89
|
export * from './logType';
|
|
89
90
|
export * from './matchLevel';
|
|
90
91
|
export * from './matchedGeoLocation';
|
|
91
|
-
export * from './mixedSearchFilters';
|
|
92
92
|
export * from './mode';
|
|
93
93
|
export * from './multipleBatchRequest';
|
|
94
94
|
export * from './multipleBatchResponse';
|
|
@@ -107,10 +107,12 @@ export * from './reRankingApplyFilter';
|
|
|
107
107
|
export * from './redirect';
|
|
108
108
|
export * from './redirectRuleIndexMetadata';
|
|
109
109
|
export * from './redirectRuleIndexMetadataData';
|
|
110
|
+
export * from './redirectURL';
|
|
110
111
|
export * from './removeStopWords';
|
|
111
112
|
export * from './removeUserIdResponse';
|
|
112
113
|
export * from './removeWordsIfNoResults';
|
|
113
114
|
export * from './renderingContent';
|
|
115
|
+
export * from './replaceAllObjectsResponse';
|
|
114
116
|
export * from './replaceSourceResponse';
|
|
115
117
|
export * from './rule';
|
|
116
118
|
export * from './saveObjectResponse';
|
|
@@ -126,6 +128,7 @@ export * from './searchForHits';
|
|
|
126
128
|
export * from './searchForHitsOptions';
|
|
127
129
|
export * from './searchHits';
|
|
128
130
|
export * from './searchMethodParams';
|
|
131
|
+
export * from './searchPagination';
|
|
129
132
|
export * from './searchParams';
|
|
130
133
|
export * from './searchParamsObject';
|
|
131
134
|
export * from './searchParamsQuery';
|
|
@@ -143,7 +146,7 @@ export * from './searchTypeDefault';
|
|
|
143
146
|
export * from './searchTypeFacet';
|
|
144
147
|
export * from './searchUserIdsParams';
|
|
145
148
|
export * from './searchUserIdsResponse';
|
|
146
|
-
export * from './
|
|
149
|
+
export * from './securedApiKeyRestrictions';
|
|
147
150
|
export * from './semanticSearch';
|
|
148
151
|
export * from './snippetResult';
|
|
149
152
|
export * from './snippetResultOption';
|
package/model/numericFilters.ts
CHANGED
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
|
-
import type { MixedSearchFilters } from './mixedSearchFilters';
|
|
4
|
-
|
|
5
3
|
/**
|
|
6
4
|
* Filter by numeric facets. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparsions are precise up to 3 decimals. You can also provide ranges: `facet:<lower> TO <upper>`. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`.
|
|
7
5
|
*/
|
|
8
|
-
export type NumericFilters =
|
|
6
|
+
export type NumericFilters = NumericFilters[] | string;
|
package/model/optionalFilters.ts
CHANGED
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
|
-
import type { MixedSearchFilters } from './mixedSearchFilters';
|
|
4
|
-
|
|
5
3
|
/**
|
|
6
4
|
* Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don\'t exclude records from the search results. Records that match the optional filter rank before records that don\'t match. If you\'re using a negative filter `facet:-value`, matching records rank after records that don\'t match. - Optional filters don\'t work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters don\'t work with numeric attributes.
|
|
7
5
|
*/
|
|
8
|
-
export type OptionalFilters =
|
|
6
|
+
export type OptionalFilters = OptionalFilters[] | string;
|
package/model/rankingInfo.ts
CHANGED
|
@@ -10,7 +10,7 @@ export type RankingInfo = {
|
|
|
10
10
|
/**
|
|
11
11
|
* Whether a filter matched the query.
|
|
12
12
|
*/
|
|
13
|
-
filters
|
|
13
|
+
filters?: number;
|
|
14
14
|
|
|
15
15
|
/**
|
|
16
16
|
* Position of the first matched word in the best matching attribute of the record.
|
|
@@ -44,7 +44,7 @@ export type RankingInfo = {
|
|
|
44
44
|
/**
|
|
45
45
|
* Whether the record was promoted by a rule.
|
|
46
46
|
*/
|
|
47
|
-
promoted
|
|
47
|
+
promoted?: boolean;
|
|
48
48
|
|
|
49
49
|
/**
|
|
50
50
|
* Number of words between multiple matches in the query plus 1. For single word queries, `proximityDistance` is 0.
|
|
@@ -59,7 +59,7 @@ export type RankingInfo = {
|
|
|
59
59
|
/**
|
|
60
60
|
* Number of matched words.
|
|
61
61
|
*/
|
|
62
|
-
words
|
|
62
|
+
words?: number;
|
|
63
63
|
|
|
64
64
|
/**
|
|
65
65
|
* Whether the record is re-ranked.
|
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
|
-
import type { MixedSearchFilters } from './mixedSearchFilters';
|
|
4
|
-
|
|
5
3
|
/**
|
|
6
4
|
* Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.
|
|
7
5
|
*/
|
|
8
|
-
export type ReRankingApplyFilter =
|
|
6
|
+
export type ReRankingApplyFilter = ReRankingApplyFilter[] | string;
|
package/model/redirect.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
import type { RedirectRuleIndexMetadata } from './redirectRuleIndexMetadata';
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
|
-
* [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/).
|
|
6
|
+
* [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/), this this parameter is for internal use only.
|
|
7
7
|
*/
|
|
8
8
|
export type Redirect = {
|
|
9
9
|
index?: RedirectRuleIndexMetadata[];
|
|
@@ -1,3 +1,8 @@
|
|
|
1
1
|
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
/**
|
|
4
|
+
* The redirect rule container.
|
|
5
|
+
*/
|
|
6
|
+
export type RedirectURL = {
|
|
7
|
+
url?: string;
|
|
8
|
+
};
|
|
@@ -1,10 +1,13 @@
|
|
|
1
1
|
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
3
|
import type { FacetOrdering } from './facetOrdering';
|
|
4
|
+
import type { RedirectURL } from './redirectURL';
|
|
4
5
|
|
|
5
6
|
/**
|
|
6
7
|
* Extra data that can be used in the search UI. You can use this to control aspects of your search UI, such as, the order of facet names and values without changing your frontend code.
|
|
7
8
|
*/
|
|
8
9
|
export type RenderingContent = {
|
|
9
10
|
facetOrdering?: FacetOrdering;
|
|
11
|
+
|
|
12
|
+
redirect?: RedirectURL;
|
|
10
13
|
};
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
import type { BatchResponse } from './batchResponse';
|
|
4
|
+
import type { UpdatedAtResponse } from './updatedAtResponse';
|
|
5
|
+
|
|
6
|
+
export type ReplaceAllObjectsResponse = {
|
|
7
|
+
copyOperationResponse: UpdatedAtResponse;
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* The response of the `batch` request(s).
|
|
11
|
+
*/
|
|
12
|
+
batchResponses: BatchResponse[];
|
|
13
|
+
|
|
14
|
+
moveOperationResponse: UpdatedAtResponse;
|
|
15
|
+
};
|