@algolia/client-search 5.0.0-alpha.5 → 5.0.0-alpha.51
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/dist/builds/browser.d.ts.map +1 -1
- package/dist/builds/node.d.ts.map +1 -1
- package/dist/client-search.cjs.js +26 -17
- package/dist/client-search.esm.browser.js +85 -130
- package/dist/client-search.esm.node.js +26 -17
- package/dist/client-search.umd.js +2 -2
- package/dist/model/acl.d.ts +1 -1
- package/dist/model/acl.d.ts.map +1 -1
- package/dist/model/action.d.ts +1 -1
- package/dist/model/action.d.ts.map +1 -1
- package/dist/model/addApiKeyResponse.d.ts +1 -1
- package/dist/model/addApiKeyResponse.d.ts.map +1 -1
- package/dist/model/advancedSyntaxFeatures.d.ts +1 -1
- package/dist/model/advancedSyntaxFeatures.d.ts.map +1 -1
- package/dist/model/alternativesAsExact.d.ts +1 -1
- package/dist/model/alternativesAsExact.d.ts.map +1 -1
- package/dist/model/anchoring.d.ts +1 -1
- package/dist/model/anchoring.d.ts.map +1 -1
- package/dist/model/apiKey.d.ts +1 -1
- package/dist/model/apiKey.d.ts.map +1 -1
- package/dist/model/aroundRadius.d.ts +1 -1
- package/dist/model/aroundRadius.d.ts.map +1 -1
- package/dist/model/aroundRadiusAll.d.ts +1 -1
- package/dist/model/aroundRadiusAll.d.ts.map +1 -1
- package/dist/model/assignUserIdParams.d.ts +1 -1
- package/dist/model/assignUserIdParams.d.ts.map +1 -1
- package/dist/model/attributeToUpdate.d.ts +1 -1
- package/dist/model/attributeToUpdate.d.ts.map +1 -1
- package/dist/model/automaticFacetFilter.d.ts +1 -1
- package/dist/model/automaticFacetFilter.d.ts.map +1 -1
- package/dist/model/automaticFacetFilters.d.ts +1 -1
- package/dist/model/automaticFacetFilters.d.ts.map +1 -1
- package/dist/model/baseGetApiKeyResponse.d.ts +1 -1
- package/dist/model/baseGetApiKeyResponse.d.ts.map +1 -1
- package/dist/model/baseIndexSettings.d.ts +5 -1
- package/dist/model/baseIndexSettings.d.ts.map +1 -1
- package/dist/model/baseSearchParams.d.ts +1 -1
- package/dist/model/baseSearchParams.d.ts.map +1 -1
- package/dist/model/baseSearchParamsWithoutQuery.d.ts +1 -1
- package/dist/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
- package/dist/model/baseSearchResponse.d.ts +2 -2
- package/dist/model/baseSearchResponse.d.ts.map +1 -1
- package/dist/model/batchAssignUserIdsParams.d.ts +1 -1
- package/dist/model/batchAssignUserIdsParams.d.ts.map +1 -1
- package/dist/model/batchDictionaryEntriesParams.d.ts +1 -1
- package/dist/model/batchDictionaryEntriesParams.d.ts.map +1 -1
- package/dist/model/batchDictionaryEntriesRequest.d.ts +1 -1
- package/dist/model/batchDictionaryEntriesRequest.d.ts.map +1 -1
- package/dist/model/batchParams.d.ts +1 -1
- package/dist/model/batchParams.d.ts.map +1 -1
- package/dist/model/batchRequest.d.ts +3 -3
- package/dist/model/batchRequest.d.ts.map +1 -1
- package/dist/model/batchResponse.d.ts +1 -1
- package/dist/model/batchResponse.d.ts.map +1 -1
- package/dist/model/batchWriteParams.d.ts +2 -2
- package/dist/model/batchWriteParams.d.ts.map +1 -1
- package/dist/model/browseParams.d.ts +4 -0
- package/dist/model/browseParams.d.ts.map +1 -0
- package/dist/model/browseParamsObject.d.ts +4 -0
- package/dist/model/browseParamsObject.d.ts.map +1 -0
- package/dist/model/browseResponse.d.ts +2 -2
- package/dist/model/browseResponse.d.ts.map +1 -1
- package/dist/model/builtInOperation.d.ts +1 -1
- package/dist/model/builtInOperation.d.ts.map +1 -1
- package/dist/model/builtInOperationType.d.ts +1 -1
- package/dist/model/builtInOperationType.d.ts.map +1 -1
- package/dist/model/clientMethodProps.d.ts +61 -60
- package/dist/model/clientMethodProps.d.ts.map +1 -1
- package/dist/model/condition.d.ts +1 -1
- package/dist/model/condition.d.ts.map +1 -1
- package/dist/model/consequence.d.ts +1 -1
- package/dist/model/consequence.d.ts.map +1 -1
- package/dist/model/consequenceHide.d.ts +1 -1
- package/dist/model/consequenceHide.d.ts.map +1 -1
- package/dist/model/consequenceParams.d.ts +1 -1
- package/dist/model/consequenceParams.d.ts.map +1 -1
- package/dist/model/consequenceQuery.d.ts +1 -1
- package/dist/model/consequenceQuery.d.ts.map +1 -1
- package/dist/model/consequenceQueryObject.d.ts +1 -1
- package/dist/model/consequenceQueryObject.d.ts.map +1 -1
- package/dist/model/createdAtResponse.d.ts +1 -1
- package/dist/model/createdAtResponse.d.ts.map +1 -1
- package/dist/model/{baseBrowseResponse.d.ts → cursor.d.ts} +3 -3
- package/dist/model/cursor.d.ts.map +1 -0
- package/dist/model/deleteApiKeyResponse.d.ts +1 -1
- package/dist/model/deleteApiKeyResponse.d.ts.map +1 -1
- package/dist/model/deleteByParams.d.ts +27 -0
- package/dist/model/deleteByParams.d.ts.map +1 -0
- package/dist/model/deleteSourceResponse.d.ts +1 -1
- package/dist/model/deleteSourceResponse.d.ts.map +1 -1
- package/dist/model/deletedAtResponse.d.ts +1 -1
- package/dist/model/deletedAtResponse.d.ts.map +1 -1
- package/dist/model/dictionaryAction.d.ts +1 -1
- package/dist/model/dictionaryAction.d.ts.map +1 -1
- package/dist/model/dictionaryEntry.d.ts +1 -1
- package/dist/model/dictionaryEntry.d.ts.map +1 -1
- package/dist/model/dictionaryEntryState.d.ts +1 -1
- package/dist/model/dictionaryEntryState.d.ts.map +1 -1
- package/dist/model/dictionaryLanguage.d.ts +1 -1
- package/dist/model/dictionaryLanguage.d.ts.map +1 -1
- package/dist/model/dictionarySettingsParams.d.ts +1 -1
- package/dist/model/dictionarySettingsParams.d.ts.map +1 -1
- package/dist/model/dictionaryType.d.ts +1 -1
- package/dist/model/dictionaryType.d.ts.map +1 -1
- package/dist/model/distinct.d.ts +1 -1
- package/dist/model/distinct.d.ts.map +1 -1
- package/dist/model/edit.d.ts +1 -1
- package/dist/model/edit.d.ts.map +1 -1
- package/dist/model/editType.d.ts +1 -1
- package/dist/model/editType.d.ts.map +1 -1
- package/dist/model/errorBase.d.ts +1 -1
- package/dist/model/errorBase.d.ts.map +1 -1
- package/dist/model/exactOnSingleWordQuery.d.ts +1 -1
- package/dist/model/exactOnSingleWordQuery.d.ts.map +1 -1
- package/dist/model/facetFilters.d.ts +1 -1
- package/dist/model/facetFilters.d.ts.map +1 -1
- package/dist/model/facetHits.d.ts +1 -1
- package/dist/model/facetHits.d.ts.map +1 -1
- package/dist/model/facetOrdering.d.ts +1 -1
- package/dist/model/facetOrdering.d.ts.map +1 -1
- package/dist/model/facets.d.ts +1 -1
- package/dist/model/facets.d.ts.map +1 -1
- package/dist/model/facetsStats.d.ts +1 -1
- package/dist/model/facetsStats.d.ts.map +1 -1
- package/dist/model/fetchedIndex.d.ts +2 -2
- package/dist/model/fetchedIndex.d.ts.map +1 -1
- package/dist/model/getApiKeyResponse.d.ts +1 -1
- package/dist/model/getApiKeyResponse.d.ts.map +1 -1
- package/dist/model/getDictionarySettingsResponse.d.ts +1 -1
- package/dist/model/getDictionarySettingsResponse.d.ts.map +1 -1
- package/dist/model/getLogsResponse.d.ts +1 -1
- package/dist/model/getLogsResponse.d.ts.map +1 -1
- package/dist/model/getObjectsParams.d.ts +1 -1
- package/dist/model/getObjectsParams.d.ts.map +1 -1
- package/dist/model/getObjectsRequest.d.ts +1 -1
- package/dist/model/getObjectsRequest.d.ts.map +1 -1
- package/dist/model/getObjectsResponse.d.ts +1 -1
- package/dist/model/getObjectsResponse.d.ts.map +1 -1
- package/dist/model/getTaskResponse.d.ts +1 -1
- package/dist/model/getTaskResponse.d.ts.map +1 -1
- package/dist/model/getTopUserIdsResponse.d.ts +1 -1
- package/dist/model/getTopUserIdsResponse.d.ts.map +1 -1
- package/dist/model/hasPendingMappingsResponse.d.ts +1 -1
- package/dist/model/hasPendingMappingsResponse.d.ts.map +1 -1
- package/dist/model/highlightResult.d.ts +1 -1
- package/dist/model/highlightResult.d.ts.map +1 -1
- package/dist/model/highlightResultOption.d.ts +1 -1
- package/dist/model/highlightResultOption.d.ts.map +1 -1
- package/dist/model/hit.d.ts +1 -1
- package/dist/model/hit.d.ts.map +1 -1
- package/dist/model/ignorePlurals.d.ts +1 -1
- package/dist/model/ignorePlurals.d.ts.map +1 -1
- package/dist/model/index.d.ts +4 -3
- package/dist/model/index.d.ts.map +1 -1
- package/dist/model/indexSettings.d.ts +1 -1
- package/dist/model/indexSettings.d.ts.map +1 -1
- package/dist/model/indexSettingsAsSearchParams.d.ts +5 -5
- package/dist/model/indexSettingsAsSearchParams.d.ts.map +1 -1
- package/dist/model/languages.d.ts +1 -1
- package/dist/model/languages.d.ts.map +1 -1
- package/dist/model/listApiKeysResponse.d.ts +1 -1
- package/dist/model/listApiKeysResponse.d.ts.map +1 -1
- package/dist/model/listClustersResponse.d.ts +1 -1
- package/dist/model/listClustersResponse.d.ts.map +1 -1
- package/dist/model/listIndicesResponse.d.ts +1 -1
- package/dist/model/listIndicesResponse.d.ts.map +1 -1
- package/dist/model/listUserIdsResponse.d.ts +1 -1
- package/dist/model/listUserIdsResponse.d.ts.map +1 -1
- package/dist/model/log.d.ts +1 -1
- package/dist/model/log.d.ts.map +1 -1
- package/dist/model/logQuery.d.ts +1 -1
- package/dist/model/logQuery.d.ts.map +1 -1
- package/dist/model/logType.d.ts +1 -1
- package/dist/model/logType.d.ts.map +1 -1
- package/dist/model/matchLevel.d.ts +1 -1
- package/dist/model/matchLevel.d.ts.map +1 -1
- package/dist/model/matchedGeoLocation.d.ts +1 -1
- package/dist/model/matchedGeoLocation.d.ts.map +1 -1
- package/dist/model/mixedSearchFilters.d.ts +1 -1
- package/dist/model/mixedSearchFilters.d.ts.map +1 -1
- package/dist/model/multipleBatchRequest.d.ts +1 -1
- package/dist/model/multipleBatchRequest.d.ts.map +1 -1
- package/dist/model/multipleBatchResponse.d.ts +1 -1
- package/dist/model/multipleBatchResponse.d.ts.map +1 -1
- package/dist/model/numericFilters.d.ts +1 -1
- package/dist/model/numericFilters.d.ts.map +1 -1
- package/dist/model/operationIndexParams.d.ts +1 -1
- package/dist/model/operationIndexParams.d.ts.map +1 -1
- package/dist/model/operationType.d.ts +1 -1
- package/dist/model/operationType.d.ts.map +1 -1
- package/dist/model/optionalFilters.d.ts +1 -1
- package/dist/model/optionalFilters.d.ts.map +1 -1
- package/dist/model/params.d.ts +1 -1
- package/dist/model/params.d.ts.map +1 -1
- package/dist/model/personalization.d.ts +1 -1
- package/dist/model/personalization.d.ts.map +1 -1
- package/dist/model/promote.d.ts +1 -1
- package/dist/model/promote.d.ts.map +1 -1
- package/dist/model/promoteObjectID.d.ts +1 -1
- package/dist/model/promoteObjectID.d.ts.map +1 -1
- package/dist/model/promoteObjectIDs.d.ts +1 -1
- package/dist/model/promoteObjectIDs.d.ts.map +1 -1
- package/dist/model/queryType.d.ts +1 -1
- package/dist/model/queryType.d.ts.map +1 -1
- package/dist/model/rankingInfo.d.ts +1 -1
- package/dist/model/rankingInfo.d.ts.map +1 -1
- package/dist/model/reRankingApplyFilter.d.ts +1 -1
- package/dist/model/reRankingApplyFilter.d.ts.map +1 -1
- package/dist/model/removeStopWords.d.ts +1 -1
- package/dist/model/removeStopWords.d.ts.map +1 -1
- package/dist/model/removeUserIdResponse.d.ts +1 -1
- package/dist/model/removeUserIdResponse.d.ts.map +1 -1
- package/dist/model/removeWordsIfNoResults.d.ts +1 -1
- package/dist/model/removeWordsIfNoResults.d.ts.map +1 -1
- package/dist/model/renderingContent.d.ts +1 -1
- package/dist/model/renderingContent.d.ts.map +1 -1
- package/dist/model/replaceSourceResponse.d.ts +1 -1
- package/dist/model/replaceSourceResponse.d.ts.map +1 -1
- package/dist/model/rule.d.ts +1 -1
- package/dist/model/rule.d.ts.map +1 -1
- package/dist/model/saveObjectResponse.d.ts +1 -1
- package/dist/model/saveObjectResponse.d.ts.map +1 -1
- package/dist/model/saveSynonymResponse.d.ts +1 -1
- package/dist/model/saveSynonymResponse.d.ts.map +1 -1
- package/dist/model/scopeType.d.ts +1 -1
- package/dist/model/scopeType.d.ts.map +1 -1
- package/dist/model/searchDictionaryEntriesParams.d.ts +1 -1
- package/dist/model/searchDictionaryEntriesParams.d.ts.map +1 -1
- package/dist/model/searchForFacetValuesRequest.d.ts +1 -1
- package/dist/model/searchForFacetValuesRequest.d.ts.map +1 -1
- package/dist/model/searchForFacetValuesResponse.d.ts +1 -1
- package/dist/model/searchForFacetValuesResponse.d.ts.map +1 -1
- package/dist/model/searchForFacets.d.ts +1 -1
- package/dist/model/searchForFacets.d.ts.map +1 -1
- package/dist/model/searchForFacetsOptions.d.ts +1 -1
- package/dist/model/searchForFacetsOptions.d.ts.map +1 -1
- package/dist/model/searchForHits.d.ts +1 -1
- package/dist/model/searchForHits.d.ts.map +1 -1
- package/dist/model/searchForHitsOptions.d.ts +1 -1
- package/dist/model/searchForHitsOptions.d.ts.map +1 -1
- package/dist/model/searchHits.d.ts +1 -1
- package/dist/model/searchHits.d.ts.map +1 -1
- package/dist/model/searchMethodParams.d.ts +1 -1
- package/dist/model/searchMethodParams.d.ts.map +1 -1
- package/dist/model/searchParams.d.ts +1 -1
- package/dist/model/searchParams.d.ts.map +1 -1
- package/dist/model/searchParamsObject.d.ts +1 -1
- package/dist/model/searchParamsObject.d.ts.map +1 -1
- package/dist/model/searchParamsQuery.d.ts +1 -1
- package/dist/model/searchParamsQuery.d.ts.map +1 -1
- package/dist/model/searchParamsString.d.ts +1 -1
- package/dist/model/searchParamsString.d.ts.map +1 -1
- package/dist/model/searchQuery.d.ts +1 -1
- package/dist/model/searchQuery.d.ts.map +1 -1
- package/dist/model/searchResponse.d.ts +1 -1
- package/dist/model/searchResponse.d.ts.map +1 -1
- package/dist/model/searchResponses.d.ts +1 -1
- package/dist/model/searchResponses.d.ts.map +1 -1
- package/dist/model/searchRulesParams.d.ts +2 -2
- package/dist/model/searchRulesParams.d.ts.map +1 -1
- package/dist/model/searchRulesResponse.d.ts +1 -1
- package/dist/model/searchRulesResponse.d.ts.map +1 -1
- package/dist/model/searchStrategy.d.ts +1 -1
- package/dist/model/searchStrategy.d.ts.map +1 -1
- package/dist/model/searchSynonymsParams.d.ts +1 -1
- package/dist/model/searchSynonymsParams.d.ts.map +1 -1
- package/dist/model/searchSynonymsResponse.d.ts +1 -1
- package/dist/model/searchSynonymsResponse.d.ts.map +1 -1
- package/dist/model/searchTypeDefault.d.ts +1 -1
- package/dist/model/searchTypeDefault.d.ts.map +1 -1
- package/dist/model/searchTypeFacet.d.ts +1 -1
- package/dist/model/searchTypeFacet.d.ts.map +1 -1
- package/dist/model/searchUserIdsParams.d.ts +1 -1
- package/dist/model/searchUserIdsParams.d.ts.map +1 -1
- package/dist/model/searchUserIdsResponse.d.ts +1 -1
- package/dist/model/searchUserIdsResponse.d.ts.map +1 -1
- package/dist/model/snippetResult.d.ts +1 -1
- package/dist/model/snippetResult.d.ts.map +1 -1
- package/dist/model/snippetResultOption.d.ts +1 -1
- package/dist/model/snippetResultOption.d.ts.map +1 -1
- package/dist/model/sortRemainingBy.d.ts +1 -1
- package/dist/model/sortRemainingBy.d.ts.map +1 -1
- package/dist/model/source.d.ts +1 -1
- package/dist/model/source.d.ts.map +1 -1
- package/dist/model/standardEntries.d.ts +1 -1
- package/dist/model/standardEntries.d.ts.map +1 -1
- package/dist/model/synonymHit.d.ts +1 -3
- package/dist/model/synonymHit.d.ts.map +1 -1
- package/dist/model/synonymType.d.ts +1 -1
- package/dist/model/synonymType.d.ts.map +1 -1
- package/dist/model/tagFilters.d.ts +1 -1
- package/dist/model/tagFilters.d.ts.map +1 -1
- package/dist/model/taskStatus.d.ts +1 -1
- package/dist/model/taskStatus.d.ts.map +1 -1
- package/dist/model/timeRange.d.ts +1 -1
- package/dist/model/timeRange.d.ts.map +1 -1
- package/dist/model/typoTolerance.d.ts +1 -1
- package/dist/model/typoTolerance.d.ts.map +1 -1
- package/dist/model/typoToleranceEnum.d.ts +1 -1
- package/dist/model/typoToleranceEnum.d.ts.map +1 -1
- package/dist/model/updateApiKeyResponse.d.ts +1 -1
- package/dist/model/updateApiKeyResponse.d.ts.map +1 -1
- package/dist/model/updatedAtResponse.d.ts +1 -1
- package/dist/model/updatedAtResponse.d.ts.map +1 -1
- package/dist/model/updatedAtWithObjectIdResponse.d.ts +1 -1
- package/dist/model/updatedAtWithObjectIdResponse.d.ts.map +1 -1
- package/dist/model/updatedRuleResponse.d.ts +1 -1
- package/dist/model/updatedRuleResponse.d.ts.map +1 -1
- package/dist/model/userHighlightResult.d.ts +1 -1
- package/dist/model/userHighlightResult.d.ts.map +1 -1
- package/dist/model/userHit.d.ts +1 -1
- package/dist/model/userHit.d.ts.map +1 -1
- package/dist/model/userId.d.ts +1 -1
- package/dist/model/userId.d.ts.map +1 -1
- package/dist/model/value.d.ts +1 -1
- package/dist/model/value.d.ts.map +1 -1
- package/dist/src/searchClient.d.ts +12 -12
- package/dist/src/searchClient.d.ts.map +1 -1
- package/model/baseIndexSettings.ts +5 -0
- package/model/baseSearchResponse.ts +1 -1
- package/model/batchRequest.ts +2 -2
- package/model/batchWriteParams.ts +1 -1
- package/model/browseParams.ts +6 -0
- package/model/browseParamsObject.ts +6 -0
- package/model/browseResponse.ts +3 -3
- package/model/clientMethodProps.ts +4 -3
- package/model/{baseBrowseResponse.ts → cursor.ts} +2 -2
- package/model/deleteByParams.ts +36 -0
- package/model/fetchedIndex.ts +1 -1
- package/model/index.ts +4 -3
- package/model/indexSettingsAsSearchParams.ts +5 -5
- package/model/searchRulesParams.ts +1 -1
- package/model/synonymHit.ts +0 -3
- package/package.json +31 -13
- package/dist/model/baseBrowseResponse.d.ts.map +0 -1
- package/dist/model/browseRequest.d.ts +0 -11
- package/dist/model/browseRequest.d.ts.map +0 -1
- package/dist/model/synonymHitHighlightResult.d.ts +0 -12
- package/dist/model/synonymHitHighlightResult.d.ts.map +0 -1
- package/model/browseRequest.ts +0 -13
- package/model/synonymHitHighlightResult.ts +0 -15
|
@@ -45,7 +45,7 @@ import type { UpdatedAtResponse } from '../model/updatedAtResponse';
|
|
|
45
45
|
import type { UpdatedAtWithObjectIdResponse } from '../model/updatedAtWithObjectIdResponse';
|
|
46
46
|
import type { UpdatedRuleResponse } from '../model/updatedRuleResponse';
|
|
47
47
|
import type { UserId } from '../model/userId';
|
|
48
|
-
export declare const apiClientVersion = "5.0.0-alpha.
|
|
48
|
+
export declare const apiClientVersion = "5.0.0-alpha.51";
|
|
49
49
|
export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
|
|
50
50
|
transporter: import("@algolia/client-common").Transporter;
|
|
51
51
|
/**
|
|
@@ -98,12 +98,12 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
98
98
|
* @summary Helper method that iterates on the `browse` method.
|
|
99
99
|
* @param browseObjects - The browseObjects object.
|
|
100
100
|
* @param browseObjects.indexName - The index in which to perform the request.
|
|
101
|
-
* @param browseObjects.
|
|
101
|
+
* @param browseObjects.browseParams - The `browse` parameters.
|
|
102
102
|
* @param browseObjects.validate - The validator function. It receive the resolved return of the API call. By default, stops when there is no `cursor` in the response.
|
|
103
103
|
* @param browseObjects.aggregator - The function that runs right after the API call has been resolved, allows you to do anything with the response before `validate`.
|
|
104
104
|
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `browse` method and merged with the transporter requestOptions.
|
|
105
105
|
*/
|
|
106
|
-
browseObjects<T>({ indexName,
|
|
106
|
+
browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<BrowseResponse<T>>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<BrowseResponse<T>>, "aggregator">> & BrowseProps, requestOptions?: RequestOptions): Promise<BrowseResponse<T>>;
|
|
107
107
|
/**
|
|
108
108
|
* Helper: Iterate on the `searchRules` method of the client to allow aggregating rules of an index.
|
|
109
109
|
*
|
|
@@ -200,10 +200,10 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
200
200
|
* @summary Retrieve all index content.
|
|
201
201
|
* @param browse - The browse object.
|
|
202
202
|
* @param browse.indexName - The index in which to perform the request.
|
|
203
|
-
* @param browse.
|
|
203
|
+
* @param browse.browseParams - The browseParams object.
|
|
204
204
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
205
205
|
*/
|
|
206
|
-
browse<T_1>({ indexName,
|
|
206
|
+
browse<T_1>({ indexName, browseParams }: BrowseProps, requestOptions?: RequestOptions): Promise<BrowseResponse<T_1>>;
|
|
207
207
|
/**
|
|
208
208
|
* Remove all synonyms from an index.
|
|
209
209
|
*
|
|
@@ -258,10 +258,10 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
258
258
|
* @summary Delete all records matching the query.
|
|
259
259
|
* @param deleteBy - The deleteBy object.
|
|
260
260
|
* @param deleteBy.indexName - The index in which to perform the request.
|
|
261
|
-
* @param deleteBy.
|
|
261
|
+
* @param deleteBy.deleteByParams - The deleteByParams object.
|
|
262
262
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
263
263
|
*/
|
|
264
|
-
deleteBy({ indexName,
|
|
264
|
+
deleteBy({ indexName, deleteByParams }: DeleteByProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
|
|
265
265
|
/**
|
|
266
266
|
* Delete an existing index.
|
|
267
267
|
*
|
|
@@ -356,7 +356,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
356
356
|
* @param getLogs.type - Type of log entries to retrieve. When omitted, all log entries are retrieved.
|
|
357
357
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
358
358
|
*/
|
|
359
|
-
getLogs({ offset, length, indexName, type }
|
|
359
|
+
getLogs({ offset, length, indexName, type }?: GetLogsProps, requestOptions?: RequestOptions | undefined): Promise<GetLogsResponse>;
|
|
360
360
|
/**
|
|
361
361
|
* Retrieve one object from the index.
|
|
362
362
|
*
|
|
@@ -446,7 +446,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
446
446
|
* @param hasPendingMappings.getClusters - If the clusters pending mapping state should be on the response.
|
|
447
447
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
448
448
|
*/
|
|
449
|
-
hasPendingMappings({ getClusters }
|
|
449
|
+
hasPendingMappings({ getClusters }?: HasPendingMappingsProps, requestOptions?: RequestOptions | undefined): Promise<HasPendingMappingsResponse>;
|
|
450
450
|
/**
|
|
451
451
|
* List API keys, along with their associated rights.
|
|
452
452
|
*
|
|
@@ -469,7 +469,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
469
469
|
* @param listIndices.page - Requested page (zero-based). When specified, will retrieve a specific page; the page size is implicitly set to 100. When null, will retrieve all indices (no pagination).
|
|
470
470
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
471
471
|
*/
|
|
472
|
-
listIndices({ page }
|
|
472
|
+
listIndices({ page }?: ListIndicesProps, requestOptions?: RequestOptions | undefined): Promise<ListIndicesResponse>;
|
|
473
473
|
/**
|
|
474
474
|
* List the userIDs assigned to a multi-clusters appID. The data returned will usually be a few seconds behind real time, because userID usage may take up to a few seconds to propagate to the different clusters. Upon success, the response is 200 OK and contains the following userIDs data.
|
|
475
475
|
*
|
|
@@ -479,7 +479,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
479
479
|
* @param listUserIds.hitsPerPage - Maximum number of objects to retrieve.
|
|
480
480
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
481
481
|
*/
|
|
482
|
-
listUserIds({ page, hitsPerPage }
|
|
482
|
+
listUserIds({ page, hitsPerPage }?: ListUserIdsProps, requestOptions?: RequestOptions | undefined): Promise<ListUserIdsResponse>;
|
|
483
483
|
/**
|
|
484
484
|
* Perform multiple write operations, potentially targeting multiple indices, in a single API call.
|
|
485
485
|
*
|
|
@@ -720,5 +720,5 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
720
720
|
/**
|
|
721
721
|
* The client type.
|
|
722
722
|
*/
|
|
723
|
-
export
|
|
723
|
+
export type SearchClient = ReturnType<typeof createSearchClient>;
|
|
724
724
|
//# sourceMappingURL=searchClient.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"searchClient.d.ts","sourceRoot":"","sources":["
|
|
1
|
+
{"version":3,"file":"searchClient.d.ts","sourceRoot":"","sources":["../../src/searchClient.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEd,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;AACxD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EACV,aAAa,EACb,kBAAkB,EAClB,oBAAoB,EACpB,sBAAsB,EACtB,iBAAiB,EACjB,UAAU,EACV,uBAAuB,EACvB,2BAA2B,EAC3B,WAAW,EACX,qBAAqB,EACrB,iBAAiB,EACjB,eAAe,EACf,QAAQ,EACR,iBAAiB,EACjB,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,QAAQ,EACR,cAAc,EACd,YAAY,EACZ,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,eAAe,EACf,YAAY,EACZ,cAAc,EACd,uBAAuB,EACvB,gBAAgB,EAChB,gBAAgB,EAChB,mBAAmB,EACnB,wBAAwB,EACxB,SAAS,EACT,QAAQ,EACR,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,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,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,mBAAmB,CAAC;AAsCjD,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,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;;;OAUG;6DAQE,kBAAkB,mBACJ,cAAc,GAC9B,QAAQ,eAAe,CAAC;IAgB3B;;;;;;;;;;;OAWG;oEASE,oBAAoB,mBACN,cAAc,GAC9B,QAAQ,QAAQ,GAAG,iBAAiB,CAAC;IAoDxC;;;;;;;;;;OAUG;0TAOgB,cAAc;IAoBjC;;;;;;;;;;OAUG;yEAME,cAAc,mBAAmB,CAAC,GAAG,gBAAgB,mBACvC,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IA0B/B;;;;;;;;;OASG;kFAOE,cAAc,sBAAsB,CAAC,GAAG,mBAAmB,mBAC7C,cAAc,GAC9B,QAAQ,sBAAsB,CAAC;IAwBlC;;;;;;OAMG;sBAEO,MAAM,mBACG,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;;OASG;qDAE8B,sBAAsB,mBACpC,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAoCzC;;;;;;OAMG;yBAEO,MAAM,mBACG,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;OAQG;yDAEuC,iBAAiB,mBACxC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAsC7B;;;;;;;;OAQG;2CAEgC,UAAU,mBAC1B,cAAc,GAC9B,QAAQ,aAAa,CAAC;IAqCzB;;;;;;;;OAQG;qEAE6C,uBAAuB,mBACpD,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA2C7B;;;;;;;;OAQG;8EAKE,2BAA2B,mBACb,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAqC7B;;;;;;;;OAQG;6CAE4B,WAAW,mBACvB,cAAc;IA0BjC;;;;;;;;OAQG;uDAEiC,qBAAqB,mBACtC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;OAOG;gCAEc,iBAAiB,mBACf,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;;;;OAQG;iDAEiC,eAAe,mBAChC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;OAOG;0BAEQ,iBAAiB,mBACT,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;;;OAQG;4CAE8B,aAAa,mBAC3B,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA+B7B;;;;;;;OAOG;+BAEc,gBAAgB,mBACd,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;;;;OAQG;0CAEwB,iBAAiB,mBACzB,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA6B7B;;;;;;;;;OASG;2DAE2C,eAAe,mBAC1C,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAiC7B;;;;;;;OAOG;6BAEW,iBAAiB,mBACZ,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;;;;OASG;8DAE2C,kBAAkB,mBAC7C,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAiC7B;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;OAOG;uBAEQ,cAAc,mBACN,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;OAKG;4CAEgB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,SAAS,CAAC,CAAC;IAerC;;;;;OAKG;2CAEgB,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAezC;;;;;;;;;;OAUG;kDAEoC,YAAY,mBACjC,cAAc,GAAG,SAAS,GACzC,QAAQ,eAAe,CAAC;IA+B3B;;;;;;;;;OASG;6DAE8C,cAAc,mBAC5C,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,MAAM,CAAC,CAAC;IAiClC;;;;;;OAMG;sCAEiB,gBAAgB,mBACjB,cAAc;IA+BjC;;;;;;;;OAQG;qCAEwB,YAAY,mBACpB,cAAc,GAC9B,QAAQ,IAAI,CAAC;IA6BhB;;;;;;;OAOG;+BAEc,gBAAgB,mBACd,cAAc,GAC9B,QAAQ,aAAa,CAAC;IAwBzB;;;;;OAKG;gCACyB,cAAc,GAAG,QAAQ,MAAM,EAAE,CAAC;IAe9D;;;;;;;;OAQG;wCAEwB,eAAe,mBACvB,cAAc,GAC9B,QAAQ,UAAU,CAAC;IA6BtB;;;;;;;;OAQG;mCAEsB,YAAY,mBAClB,cAAc,GAC9B,QAAQ,eAAe,CAAC;IA6B3B;;;;;OAKG;mCAEgB,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IAejC;;;;;;;OAOG;0BAEW,cAAc,mBACT,cAAc,GAC9B,QAAQ,MAAM,CAAC;IAwBlB;;;;;;;OAOG;yCAEgB,uBAAuB,mBACxB,cAAc,GAAG,SAAS,GACzC,QAAQ,0BAA0B,CAAC;IAmBtC;;;;;OAKG;iCAC0B,cAAc,GAAG,QAAQ,mBAAmB,CAAC;IAe1E;;;;;OAKG;kCAEgB,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAehC;;;;;;;OAOG;2BAES,gBAAgB,mBACV,cAAc,GAAG,SAAS,GACzC,QAAQ,mBAAmB,CAAC;IAmB/B;;;;;;;;OAQG;wCAEsB,gBAAgB,mBACvB,cAAc,GAAG,SAAS,GACzC,QAAQ,mBAAmB,CAAC;IAuB/B;;;;;;OAMG;+BAEY,WAAW,mBACP,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IA4BjC;;;;;;;;OAQG;wDAEoC,mBAAmB,mBACvC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA0C7B;;;;;;;;;;OAUG;yFAOE,wBAAwB,mBACV,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAwCzC;;;;;;;;;OASG;qCAE2B,SAAS,mBACpB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;;;OASG;oCAE2B,QAAQ,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;OAOG;6BAEW,iBAAiB,mBACZ,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;;OAOG;+BAEW,mBAAmB,mBACd,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IAsBjC;;;;;;;OAOG;2BAEQ,kBAAkB,mBACV,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;;;;OAQG;oCAEoB,eAAe,mBACnB,cAAc,GAC9B,QAAQ,kBAAkB,CAAC;IA+B9B;;;;;;;;;;OAUG;+DAEiD,aAAa,mBAC9C,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IA8C/B;;;;;;;;;;OAUG;4EAOE,cAAc,mBACA,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAuC7B;;;;;;;;;;OAUG;wEAEuD,gBAAgB,mBACvD,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IAmD/B;;;;;;;;;;OAUG;yFAOE,iBAAiB,mBACH,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwC7B;;;;;;OAMG;oCAEmB,uBAAuB,GAAG,kBAAkB,mBAC/C,cAAc;IAwDjC;;;;;;;;OAQG;gFAKE,4BAA4B,mBACd,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAuC7B;;;;;;;;;OASG;iFAME,yBAAyB,mBACX,cAAc,GAC9B,QAAQ,4BAA4B,CAAC;IAgCxC;;;;;;;;OAQG;kDAEiC,gBAAgB,mBACjC,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IA2B/B;;;;;;;;OAQG;wDAE4B,sBAAsB,mBAClC,cAAc;IA4BjC;;;;;;;;;;;OAWG;kFAQE,mBAAmB,mBACL,cAAc,GAC9B,QAAQ,sBAAsB,CAAC;IAuClC;;;;;;OAMG;uCAEoB,mBAAmB,mBACvB,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IA8BjC;;;;;;OAMG;oDAEyB,wBAAwB,mBACjC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;;OASG;iEAEgD,gBAAgB,mBAChD,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAmC7B;;;;;;;;OAQG;kCAEgB,iBAAiB,mBACjB,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;EAqCnC;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC"}
|
|
@@ -11,6 +11,11 @@ export type BaseIndexSettings = {
|
|
|
11
11
|
*/
|
|
12
12
|
paginationLimitedTo?: number;
|
|
13
13
|
|
|
14
|
+
/**
|
|
15
|
+
* List of attributes that can\'t be retrieved at query time.
|
|
16
|
+
*/
|
|
17
|
+
unretrievableAttributes?: string[];
|
|
18
|
+
|
|
14
19
|
/**
|
|
15
20
|
* A list of words for which you want to turn off typo tolerance.
|
|
16
21
|
*/
|
|
@@ -37,7 +37,7 @@ export type BaseSearchResponse = {
|
|
|
37
37
|
/**
|
|
38
38
|
* Indicate if the typo-tolerance search was exhaustive or approximate (only included when typo-tolerance is enabled).
|
|
39
39
|
*/
|
|
40
|
-
exhaustiveTypo
|
|
40
|
+
exhaustiveTypo?: boolean;
|
|
41
41
|
|
|
42
42
|
/**
|
|
43
43
|
* A mapping of each facet name to the corresponding facet counts.
|
package/model/batchRequest.ts
CHANGED
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
import type { Action } from './action';
|
|
4
4
|
|
|
5
5
|
export type BatchRequest = {
|
|
6
|
-
action
|
|
6
|
+
action: Action;
|
|
7
7
|
|
|
8
8
|
/**
|
|
9
9
|
* Arguments to the operation (depends on the type of the operation).
|
|
10
10
|
*/
|
|
11
|
-
body
|
|
11
|
+
body: Record<string, any>;
|
|
12
12
|
};
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
|
|
2
|
+
|
|
3
|
+
import type { BrowseParamsObject } from './browseParamsObject';
|
|
4
|
+
import type { SearchParamsString } from './searchParamsString';
|
|
5
|
+
|
|
6
|
+
export type BrowseParams = BrowseParamsObject | SearchParamsString;
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
|
|
2
|
+
|
|
3
|
+
import type { Cursor } from './cursor';
|
|
4
|
+
import type { SearchParamsObject } from './searchParamsObject';
|
|
5
|
+
|
|
6
|
+
export type BrowseParamsObject = Cursor & SearchParamsObject;
|
package/model/browseResponse.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
|
|
2
2
|
|
|
3
|
-
import type { BaseBrowseResponse } from './baseBrowseResponse';
|
|
4
3
|
import type { BaseSearchResponse } from './baseSearchResponse';
|
|
4
|
+
import type { Cursor } from './cursor';
|
|
5
5
|
import type { SearchHits } from './searchHits';
|
|
6
6
|
|
|
7
|
-
export type BrowseResponse<T = Record<string, any>> =
|
|
8
|
-
|
|
7
|
+
export type BrowseResponse<T = Record<string, any>> = BaseSearchResponse &
|
|
8
|
+
Cursor &
|
|
9
9
|
SearchHits<T>;
|
|
@@ -8,7 +8,8 @@ import type { AttributeToUpdate } from './attributeToUpdate';
|
|
|
8
8
|
import type { BatchAssignUserIdsParams } from './batchAssignUserIdsParams';
|
|
9
9
|
import type { BatchDictionaryEntriesParams } from './batchDictionaryEntriesParams';
|
|
10
10
|
import type { BatchWriteParams } from './batchWriteParams';
|
|
11
|
-
import type {
|
|
11
|
+
import type { BrowseParams } from './browseParams';
|
|
12
|
+
import type { DeleteByParams } from './deleteByParams';
|
|
12
13
|
import type { DictionaryType } from './dictionaryType';
|
|
13
14
|
import type { IndexSettings } from './indexSettings';
|
|
14
15
|
import type { LogType } from './logType';
|
|
@@ -96,7 +97,7 @@ export type BrowseProps = {
|
|
|
96
97
|
* The index in which to perform the request.
|
|
97
98
|
*/
|
|
98
99
|
indexName: string;
|
|
99
|
-
|
|
100
|
+
browseParams?: BrowseParams;
|
|
100
101
|
};
|
|
101
102
|
|
|
102
103
|
/**
|
|
@@ -169,7 +170,7 @@ export type DeleteByProps = {
|
|
|
169
170
|
* The index in which to perform the request.
|
|
170
171
|
*/
|
|
171
172
|
indexName: string;
|
|
172
|
-
|
|
173
|
+
deleteByParams: DeleteByParams;
|
|
173
174
|
};
|
|
174
175
|
|
|
175
176
|
/**
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
|
|
2
2
|
|
|
3
|
-
export type
|
|
3
|
+
export type Cursor = {
|
|
4
4
|
/**
|
|
5
5
|
* Cursor indicating the location to resume browsing from. Must match the value returned by the previous call.
|
|
6
6
|
*/
|
|
7
|
-
cursor
|
|
7
|
+
cursor?: string;
|
|
8
8
|
};
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
|
|
2
|
+
|
|
3
|
+
import type { AroundRadius } from './aroundRadius';
|
|
4
|
+
import type { FacetFilters } from './facetFilters';
|
|
5
|
+
import type { NumericFilters } from './numericFilters';
|
|
6
|
+
import type { TagFilters } from './tagFilters';
|
|
7
|
+
|
|
8
|
+
export type DeleteByParams = {
|
|
9
|
+
facetFilters?: FacetFilters;
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* Filter the query with numeric, facet and/or tag filters.
|
|
13
|
+
*/
|
|
14
|
+
filters?: string;
|
|
15
|
+
|
|
16
|
+
numericFilters?: NumericFilters;
|
|
17
|
+
|
|
18
|
+
tagFilters?: TagFilters;
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* Search for entries around a central geolocation, enabling a geo search within a circular area.
|
|
22
|
+
*/
|
|
23
|
+
aroundLatLng?: string;
|
|
24
|
+
|
|
25
|
+
aroundRadius?: AroundRadius;
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Search inside a rectangular area (in geo coordinates).
|
|
29
|
+
*/
|
|
30
|
+
insideBoundingBox?: number[];
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* Search inside a polygon (in geo coordinates).
|
|
34
|
+
*/
|
|
35
|
+
insidePolygon?: number[];
|
|
36
|
+
};
|
package/model/fetchedIndex.ts
CHANGED
|
@@ -39,7 +39,7 @@ export type FetchedIndex = {
|
|
|
39
39
|
/**
|
|
40
40
|
* Number of pending indexing operations. This value is deprecated and should not be used.
|
|
41
41
|
*/
|
|
42
|
-
|
|
42
|
+
numberOfPendingTasks: number;
|
|
43
43
|
|
|
44
44
|
/**
|
|
45
45
|
* A boolean which says whether the index has pending tasks. This value is deprecated and should not be used.
|
package/model/index.ts
CHANGED
|
@@ -13,7 +13,6 @@ export * from './assignUserIdParams';
|
|
|
13
13
|
export * from './attributeToUpdate';
|
|
14
14
|
export * from './automaticFacetFilter';
|
|
15
15
|
export * from './automaticFacetFilters';
|
|
16
|
-
export * from './baseBrowseResponse';
|
|
17
16
|
export * from './baseGetApiKeyResponse';
|
|
18
17
|
export * from './baseIndexSettings';
|
|
19
18
|
export * from './baseSearchParams';
|
|
@@ -26,7 +25,8 @@ export * from './batchParams';
|
|
|
26
25
|
export * from './batchRequest';
|
|
27
26
|
export * from './batchResponse';
|
|
28
27
|
export * from './batchWriteParams';
|
|
29
|
-
export * from './
|
|
28
|
+
export * from './browseParams';
|
|
29
|
+
export * from './browseParamsObject';
|
|
30
30
|
export * from './browseResponse';
|
|
31
31
|
export * from './builtInOperation';
|
|
32
32
|
export * from './builtInOperationType';
|
|
@@ -37,7 +37,9 @@ export * from './consequenceParams';
|
|
|
37
37
|
export * from './consequenceQuery';
|
|
38
38
|
export * from './consequenceQueryObject';
|
|
39
39
|
export * from './createdAtResponse';
|
|
40
|
+
export * from './cursor';
|
|
40
41
|
export * from './deleteApiKeyResponse';
|
|
42
|
+
export * from './deleteByParams';
|
|
41
43
|
export * from './deleteSourceResponse';
|
|
42
44
|
export * from './deletedAtResponse';
|
|
43
45
|
export * from './dictionaryAction';
|
|
@@ -137,7 +139,6 @@ export * from './sortRemainingBy';
|
|
|
137
139
|
export * from './source';
|
|
138
140
|
export * from './standardEntries';
|
|
139
141
|
export * from './synonymHit';
|
|
140
|
-
export * from './synonymHitHighlightResult';
|
|
141
142
|
export * from './synonymType';
|
|
142
143
|
export * from './tagFilters';
|
|
143
144
|
export * from './taskStatus';
|
|
@@ -17,11 +17,6 @@ export type IndexSettingsAsSearchParams = {
|
|
|
17
17
|
*/
|
|
18
18
|
attributesForFaceting?: string[];
|
|
19
19
|
|
|
20
|
-
/**
|
|
21
|
-
* List of attributes that can\'t be retrieved at query time.
|
|
22
|
-
*/
|
|
23
|
-
unretrievableAttributes?: string[];
|
|
24
|
-
|
|
25
20
|
/**
|
|
26
21
|
* This parameter controls which attributes to retrieve and which not to retrieve.
|
|
27
22
|
*/
|
|
@@ -166,6 +161,11 @@ export type IndexSettingsAsSearchParams = {
|
|
|
166
161
|
|
|
167
162
|
distinct?: Distinct;
|
|
168
163
|
|
|
164
|
+
/**
|
|
165
|
+
* Name of the de-duplication attribute to be used with the distinct feature.
|
|
166
|
+
*/
|
|
167
|
+
attributeForDistinct?: string;
|
|
168
|
+
|
|
169
169
|
/**
|
|
170
170
|
* Whether to take into account an index\'s synonyms for a particular search.
|
|
171
171
|
*/
|
|
@@ -31,7 +31,7 @@ export type SearchRulesParams = {
|
|
|
31
31
|
/**
|
|
32
32
|
* When specified, restricts matches to rules with a specific enabled status. When absent (default), all rules are retrieved, regardless of their enabled status.
|
|
33
33
|
*/
|
|
34
|
-
enabled?: boolean;
|
|
34
|
+
enabled?: boolean | null;
|
|
35
35
|
|
|
36
36
|
/**
|
|
37
37
|
* A mapping of requestOptions to send along with the request.
|
package/model/synonymHit.ts
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
|
|
2
2
|
|
|
3
|
-
import type { SynonymHitHighlightResult } from './synonymHitHighlightResult';
|
|
4
3
|
import type { SynonymType } from './synonymType';
|
|
5
4
|
|
|
6
5
|
/**
|
|
@@ -43,6 +42,4 @@ export type SynonymHit = {
|
|
|
43
42
|
* List of query words that will match the token.
|
|
44
43
|
*/
|
|
45
44
|
replacements?: string[];
|
|
46
|
-
|
|
47
|
-
_highlightResult?: SynonymHitHighlightResult;
|
|
48
45
|
};
|
package/package.json
CHANGED
|
@@ -1,16 +1,32 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@algolia/client-search",
|
|
3
|
-
"version": "5.0.0-alpha.
|
|
3
|
+
"version": "5.0.0-alpha.51",
|
|
4
4
|
"description": "JavaScript client for client-search",
|
|
5
5
|
"repository": "algolia/algoliasearch-client-javascript",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"author": "Algolia",
|
|
8
|
-
"
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
8
|
+
"exports": {
|
|
9
|
+
".": {
|
|
10
|
+
"node": {
|
|
11
|
+
"import": "./dist/client-search.esm.node.js",
|
|
12
|
+
"module": "./dist/client-search.esm.node.js",
|
|
13
|
+
"require": "./dist/client-search.cjs.js",
|
|
14
|
+
"default": "./dist/client-search.cjs.js"
|
|
15
|
+
},
|
|
16
|
+
"default": {
|
|
17
|
+
"umd": "./dist/client-search.umd.js",
|
|
18
|
+
"module": "./dist/client-search.esm.browser.js",
|
|
19
|
+
"import": "./dist/client-search.esm.browser.js",
|
|
20
|
+
"default": "./dist/client-search.umd.js"
|
|
21
|
+
}
|
|
22
|
+
},
|
|
23
|
+
"./src/*": "./src/*.ts",
|
|
24
|
+
"./model": "./model/index.ts"
|
|
25
|
+
},
|
|
26
|
+
"jsdelivr": "./dist/client-search.umd.js",
|
|
27
|
+
"unpkg": "./dist/client-search.umd.js",
|
|
28
|
+
"browser": "./dist/client-search.umd.js",
|
|
29
|
+
"types": "./index.d.ts",
|
|
14
30
|
"files": [
|
|
15
31
|
"dist",
|
|
16
32
|
"model",
|
|
@@ -18,16 +34,18 @@
|
|
|
18
34
|
"index.d.ts"
|
|
19
35
|
],
|
|
20
36
|
"scripts": {
|
|
21
|
-
"
|
|
37
|
+
"build": "yarn clean && rollup --config",
|
|
38
|
+
"clean": "rm -rf ./dist || true"
|
|
22
39
|
},
|
|
23
40
|
"dependencies": {
|
|
24
|
-
"@algolia/client-common": "5.0.0-alpha.
|
|
25
|
-
"@algolia/requester-browser-xhr": "5.0.0-alpha.
|
|
26
|
-
"@algolia/requester-node-http": "5.0.0-alpha.
|
|
41
|
+
"@algolia/client-common": "5.0.0-alpha.51",
|
|
42
|
+
"@algolia/requester-browser-xhr": "5.0.0-alpha.51",
|
|
43
|
+
"@algolia/requester-node-http": "5.0.0-alpha.51"
|
|
27
44
|
},
|
|
28
45
|
"devDependencies": {
|
|
29
|
-
"@types/node": "
|
|
30
|
-
"
|
|
46
|
+
"@types/node": "18.14.2",
|
|
47
|
+
"rollup": "2.79.1",
|
|
48
|
+
"typescript": "4.9.5"
|
|
31
49
|
},
|
|
32
50
|
"engines": {
|
|
33
51
|
"node": ">= 14.0.0"
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"baseBrowseResponse.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/baseBrowseResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,kBAAkB,GAAG;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
export declare type BrowseRequest = {
|
|
2
|
-
/**
|
|
3
|
-
* Search parameters as URL-encoded query string.
|
|
4
|
-
*/
|
|
5
|
-
params?: string;
|
|
6
|
-
/**
|
|
7
|
-
* Cursor indicating the location to resume browsing from. Must match the value returned by the previous call.
|
|
8
|
-
*/
|
|
9
|
-
cursor?: string;
|
|
10
|
-
};
|
|
11
|
-
//# sourceMappingURL=browseRequest.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"browseRequest.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/browseRequest.ts"],"names":[],"mappings":"AAEA,oBAAY,aAAa,GAAG;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
import type { HighlightResult } from './highlightResult';
|
|
2
|
-
/**
|
|
3
|
-
* Highlighted results.
|
|
4
|
-
*/
|
|
5
|
-
export declare type SynonymHitHighlightResult = {
|
|
6
|
-
/**
|
|
7
|
-
* Show highlighted section and words matched on a query.
|
|
8
|
-
*/
|
|
9
|
-
type?: Record<string, HighlightResult>;
|
|
10
|
-
synonyms?: Array<Record<string, HighlightResult>>;
|
|
11
|
-
};
|
|
12
|
-
//# sourceMappingURL=synonymHitHighlightResult.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"synonymHitHighlightResult.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/synonymHitHighlightResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD;;GAEG;AACH,oBAAY,yBAAyB,GAAG;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAEvC,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC;CACnD,CAAC"}
|
package/model/browseRequest.ts
DELETED
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
|
|
2
|
-
|
|
3
|
-
export type BrowseRequest = {
|
|
4
|
-
/**
|
|
5
|
-
* Search parameters as URL-encoded query string.
|
|
6
|
-
*/
|
|
7
|
-
params?: string;
|
|
8
|
-
|
|
9
|
-
/**
|
|
10
|
-
* Cursor indicating the location to resume browsing from. Must match the value returned by the previous call.
|
|
11
|
-
*/
|
|
12
|
-
cursor?: string;
|
|
13
|
-
};
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
|
|
2
|
-
|
|
3
|
-
import type { HighlightResult } from './highlightResult';
|
|
4
|
-
|
|
5
|
-
/**
|
|
6
|
-
* Highlighted results.
|
|
7
|
-
*/
|
|
8
|
-
export type SynonymHitHighlightResult = {
|
|
9
|
-
/**
|
|
10
|
-
* Show highlighted section and words matched on a query.
|
|
11
|
-
*/
|
|
12
|
-
type?: Record<string, HighlightResult>;
|
|
13
|
-
|
|
14
|
-
synonyms?: Array<Record<string, HighlightResult>>;
|
|
15
|
-
};
|