algoliasearch 5.0.0-alpha.1 → 5.0.0-alpha.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/builds/browser.ts +13 -10
- package/builds/models.ts +12 -6
- package/builds/node.ts +13 -10
- package/dist/algoliasearch/builds/browser.d.ts +23 -14
- package/dist/algoliasearch/builds/browser.d.ts.map +1 -1
- package/dist/algoliasearch/builds/node.d.ts +23 -14
- package/dist/algoliasearch/builds/node.d.ts.map +1 -1
- package/dist/algoliasearch/lite/builds/browser.d.ts +2 -2
- package/dist/algoliasearch/lite/builds/browser.d.ts.map +1 -1
- package/dist/algoliasearch/lite/builds/node.d.ts +2 -2
- package/dist/algoliasearch/lite/builds/node.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/acl.d.ts +3 -0
- package/dist/algoliasearch/lite/model/acl.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/addApiKeyResponse.d.ts +1 -1
- package/dist/algoliasearch/lite/model/addApiKeyResponse.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/apiKey.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/attributeToUpdate.d.ts +3 -0
- package/dist/algoliasearch/lite/model/attributeToUpdate.d.ts.map +1 -0
- package/dist/algoliasearch/lite/model/automaticFacetFilter.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/baseGetApiKeyResponse.d.ts +11 -0
- package/dist/algoliasearch/lite/model/baseGetApiKeyResponse.d.ts.map +1 -0
- package/dist/algoliasearch/lite/model/baseIndexSettings.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/baseSearchResponse.d.ts +2 -2
- package/dist/algoliasearch/lite/model/baseSearchResponse.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/browseResponse.d.ts +1 -1
- package/dist/algoliasearch/lite/model/browseResponse.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/builtInOperation.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/condition.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/consequence.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/consequenceQueryObject.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/dictionaryEntry.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/distinct.d.ts +5 -0
- package/dist/algoliasearch/lite/model/distinct.d.ts.map +1 -0
- package/dist/algoliasearch/lite/model/edit.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/facetOrdering.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/facetsStats.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/fetchedIndex.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/getApiKeyResponse.d.ts +4 -0
- package/dist/algoliasearch/lite/model/getApiKeyResponse.d.ts.map +1 -0
- package/dist/algoliasearch/lite/model/highlightResultOption.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/hit.d.ts +1 -1
- package/dist/algoliasearch/lite/model/hit.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/index.d.ts +4 -3
- package/dist/algoliasearch/lite/model/index.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/indexSettingsAsSearchParams.d.ts +2 -4
- package/dist/algoliasearch/lite/model/indexSettingsAsSearchParams.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/languages.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/listIndicesResponse.d.ts +1 -1
- package/dist/algoliasearch/lite/model/listIndicesResponse.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/matchedGeoLocation.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/params.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/personalization.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/promoteObjectID.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/promoteObjectIDs.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/rankingInfo.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/rule.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/searchForFacetsOptions.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/searchForHitsOptions.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/searchHits.d.ts +2 -2
- package/dist/algoliasearch/lite/model/searchHits.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/searchMethodParams.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/searchResponse.d.ts +1 -1
- package/dist/algoliasearch/lite/model/searchResponse.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/searchResponses.d.ts +1 -1
- package/dist/algoliasearch/lite/model/searchResponses.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/searchSynonymsResponse.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/snippetResultOption.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/source.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/standardEntries.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/synonymHit.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/synonymHitHighlightResult.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/timeRange.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/updatedRuleResponse.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/userId.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/value.d.ts.map +1 -1
- package/dist/algoliasearch/lite/src/liteClient.d.ts +12 -1
- package/dist/algoliasearch/lite/src/liteClient.d.ts.map +1 -1
- package/dist/algoliasearch.cjs.js +186 -28
- package/dist/algoliasearch.esm.browser.js +214 -56
- package/dist/algoliasearch.esm.node.js +187 -29
- package/dist/algoliasearch.umd.js +2 -2
- package/dist/builds/browser.d.ts +23 -14
- package/dist/builds/browser.d.ts.map +1 -1
- package/dist/builds/models.d.ts +11 -8
- package/dist/builds/models.d.ts.map +1 -1
- package/dist/builds/node.d.ts +23 -14
- package/dist/builds/node.d.ts.map +1 -1
- package/dist/client-abtesting/model/aBTest.d.ts.map +1 -1
- package/dist/client-abtesting/model/aBTestResponse.d.ts.map +1 -1
- package/dist/client-abtesting/model/abTestsVariant.d.ts.map +1 -1
- package/dist/client-abtesting/model/addABTestsRequest.d.ts.map +1 -1
- package/dist/client-abtesting/model/listABTestsResponse.d.ts.map +1 -1
- package/dist/client-abtesting/model/variant.d.ts.map +1 -1
- package/dist/client-abtesting/src/abtestingClient.d.ts +12 -1
- package/dist/client-abtesting/src/abtestingClient.d.ts.map +1 -1
- package/dist/client-analytics/model/averageClickEvent.d.ts.map +1 -1
- package/dist/client-analytics/model/clickPosition.d.ts.map +1 -1
- package/dist/client-analytics/model/clickThroughRateEvent.d.ts.map +1 -1
- package/dist/client-analytics/model/conversionRateEvent.d.ts.map +1 -1
- package/dist/client-analytics/model/getAverageClickPositionResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getClickThroughRateResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getConversationRateResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getNoClickRateResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getNoResultsRateResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getSearchesCountResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getTopFilterAttribute.d.ts.map +1 -1
- package/dist/client-analytics/model/getTopFilterForAttribute.d.ts.map +1 -1
- package/dist/client-analytics/model/getTopFiltersNoResultsValue.d.ts.map +1 -1
- package/dist/client-analytics/model/getTopFiltersNoResultsValues.d.ts.map +1 -1
- package/dist/client-analytics/model/getUsersCountResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/noClickRateEvent.d.ts.map +1 -1
- package/dist/client-analytics/model/noResultsRateEvent.d.ts.map +1 -1
- package/dist/client-analytics/model/searchEvent.d.ts.map +1 -1
- package/dist/client-analytics/model/searchNoClickEvent.d.ts.map +1 -1
- package/dist/client-analytics/model/searchNoResultEvent.d.ts.map +1 -1
- package/dist/client-analytics/model/topCountry.d.ts.map +1 -1
- package/dist/client-analytics/model/topHit.d.ts.map +1 -1
- package/dist/client-analytics/model/topHitWithAnalytics.d.ts.map +1 -1
- package/dist/client-analytics/model/topSearch.d.ts.map +1 -1
- package/dist/client-analytics/model/topSearchWithAnalytics.d.ts.map +1 -1
- package/dist/client-analytics/model/userWithDate.d.ts.map +1 -1
- package/dist/client-analytics/src/analyticsClient.d.ts +12 -1
- package/dist/client-analytics/src/analyticsClient.d.ts.map +1 -1
- package/dist/client-personalization/model/deleteUserProfileResponse.d.ts.map +1 -1
- package/dist/client-personalization/model/eventScoring.d.ts.map +1 -1
- package/dist/client-personalization/model/facetScoring.d.ts.map +1 -1
- package/dist/client-personalization/model/getUserTokenResponse.d.ts.map +1 -1
- package/dist/client-personalization/model/personalizationStrategyParams.d.ts.map +1 -1
- package/dist/client-personalization/src/personalizationClient.d.ts +12 -1
- package/dist/client-personalization/src/personalizationClient.d.ts.map +1 -1
- package/dist/client-search/model/acl.d.ts +3 -0
- package/dist/client-search/model/acl.d.ts.map +1 -1
- package/dist/client-search/model/addApiKeyResponse.d.ts +1 -1
- package/dist/client-search/model/addApiKeyResponse.d.ts.map +1 -1
- package/dist/client-search/model/apiKey.d.ts.map +1 -1
- package/dist/client-search/model/attributeToUpdate.d.ts +3 -0
- package/dist/client-search/model/attributeToUpdate.d.ts.map +1 -0
- package/dist/client-search/model/automaticFacetFilter.d.ts.map +1 -1
- package/dist/client-search/model/baseGetApiKeyResponse.d.ts +11 -0
- package/dist/client-search/model/baseGetApiKeyResponse.d.ts.map +1 -0
- package/dist/client-search/model/baseIndexSettings.d.ts.map +1 -1
- package/dist/client-search/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
- package/dist/client-search/model/baseSearchResponse.d.ts +2 -2
- package/dist/client-search/model/baseSearchResponse.d.ts.map +1 -1
- package/dist/client-search/model/batchAssignUserIdsParams.d.ts.map +1 -1
- package/dist/client-search/model/batchDictionaryEntriesParams.d.ts.map +1 -1
- package/dist/client-search/model/batchDictionaryEntriesRequest.d.ts.map +1 -1
- package/dist/client-search/model/batchParams.d.ts +2 -2
- package/dist/client-search/model/batchParams.d.ts.map +1 -1
- package/dist/client-search/model/{batchOperation.d.ts → batchRequest.d.ts} +2 -2
- package/dist/client-search/model/batchRequest.d.ts.map +1 -0
- package/dist/client-search/model/batchResponse.d.ts.map +1 -1
- package/dist/client-search/model/batchWriteParams.d.ts +2 -2
- package/dist/client-search/model/batchWriteParams.d.ts.map +1 -1
- package/dist/client-search/model/browseRequest.d.ts.map +1 -1
- package/dist/client-search/model/browseResponse.d.ts +1 -1
- package/dist/client-search/model/browseResponse.d.ts.map +1 -1
- package/dist/client-search/model/builtInOperation.d.ts.map +1 -1
- package/dist/client-search/model/clientMethodProps.d.ts +21 -8
- package/dist/client-search/model/clientMethodProps.d.ts.map +1 -1
- package/dist/client-search/model/condition.d.ts.map +1 -1
- package/dist/client-search/model/consequence.d.ts.map +1 -1
- package/dist/client-search/model/consequenceQueryObject.d.ts.map +1 -1
- package/dist/client-search/model/deletedAtResponse.d.ts.map +1 -1
- package/dist/client-search/model/dictionaryEntry.d.ts.map +1 -1
- package/dist/client-search/model/distinct.d.ts +5 -0
- package/dist/client-search/model/distinct.d.ts.map +1 -0
- package/dist/client-search/model/edit.d.ts.map +1 -1
- package/dist/client-search/model/facetHits.d.ts.map +1 -1
- package/dist/client-search/model/facetOrdering.d.ts.map +1 -1
- package/dist/client-search/model/facetsStats.d.ts.map +1 -1
- package/dist/client-search/model/fetchedIndex.d.ts.map +1 -1
- package/dist/client-search/model/getApiKeyResponse.d.ts +4 -0
- package/dist/client-search/model/getApiKeyResponse.d.ts.map +1 -0
- package/dist/client-search/model/getObjectsParams.d.ts +2 -2
- package/dist/client-search/model/getObjectsParams.d.ts.map +1 -1
- package/dist/client-search/model/{multipleGetObjectsParams.d.ts → getObjectsRequest.d.ts} +2 -2
- package/dist/client-search/model/getObjectsRequest.d.ts.map +1 -0
- package/dist/client-search/model/getObjectsResponse.d.ts +2 -2
- package/dist/client-search/model/getObjectsResponse.d.ts.map +1 -1
- package/dist/client-search/model/hasPendingMappingsResponse.d.ts.map +1 -1
- package/dist/client-search/model/highlightResultOption.d.ts.map +1 -1
- package/dist/client-search/model/hit.d.ts +1 -1
- package/dist/client-search/model/hit.d.ts.map +1 -1
- package/dist/client-search/model/index.d.ts +7 -6
- package/dist/client-search/model/index.d.ts.map +1 -1
- package/dist/client-search/model/indexSettingsAsSearchParams.d.ts +2 -4
- package/dist/client-search/model/indexSettingsAsSearchParams.d.ts.map +1 -1
- package/dist/client-search/model/languages.d.ts.map +1 -1
- package/dist/client-search/model/listApiKeysResponse.d.ts +2 -2
- package/dist/client-search/model/listApiKeysResponse.d.ts.map +1 -1
- package/dist/client-search/model/listIndicesResponse.d.ts +1 -1
- package/dist/client-search/model/listIndicesResponse.d.ts.map +1 -1
- package/dist/client-search/model/log.d.ts.map +1 -1
- package/dist/client-search/model/logQuery.d.ts.map +1 -1
- package/dist/client-search/model/matchedGeoLocation.d.ts.map +1 -1
- package/dist/client-search/model/{multipleBatchOperation.d.ts → multipleBatchRequest.d.ts} +5 -5
- package/dist/client-search/model/multipleBatchRequest.d.ts.map +1 -0
- package/dist/client-search/model/multipleBatchResponse.d.ts +2 -2
- package/dist/client-search/model/multipleBatchResponse.d.ts.map +1 -1
- package/dist/client-search/model/operationIndexParams.d.ts.map +1 -1
- package/dist/client-search/model/params.d.ts.map +1 -1
- package/dist/client-search/model/personalization.d.ts.map +1 -1
- package/dist/client-search/model/promoteObjectID.d.ts.map +1 -1
- package/dist/client-search/model/promoteObjectIDs.d.ts.map +1 -1
- package/dist/client-search/model/rankingInfo.d.ts.map +1 -1
- package/dist/client-search/model/rule.d.ts.map +1 -1
- package/dist/client-search/model/saveObjectResponse.d.ts +2 -2
- package/dist/client-search/model/saveObjectResponse.d.ts.map +1 -1
- package/dist/client-search/model/saveSynonymResponse.d.ts.map +1 -1
- package/dist/client-search/model/searchDictionaryEntriesParams.d.ts.map +1 -1
- package/dist/client-search/model/searchForFacetValuesRequest.d.ts.map +1 -1
- package/dist/client-search/model/searchForFacetsOptions.d.ts.map +1 -1
- package/dist/client-search/model/searchForHitsOptions.d.ts.map +1 -1
- package/dist/client-search/model/searchHits.d.ts +2 -2
- package/dist/client-search/model/searchHits.d.ts.map +1 -1
- package/dist/client-search/model/searchMethodParams.d.ts.map +1 -1
- package/dist/client-search/model/searchResponse.d.ts +1 -1
- package/dist/client-search/model/searchResponse.d.ts.map +1 -1
- package/dist/client-search/model/searchResponses.d.ts +1 -1
- package/dist/client-search/model/searchResponses.d.ts.map +1 -1
- package/dist/client-search/model/searchRulesParams.d.ts.map +1 -1
- package/dist/client-search/model/searchRulesResponse.d.ts.map +1 -1
- package/dist/client-search/model/searchSynonymsResponse.d.ts.map +1 -1
- package/dist/client-search/model/searchUserIdsParams.d.ts.map +1 -1
- package/dist/client-search/model/searchUserIdsResponse.d.ts.map +1 -1
- package/dist/client-search/model/snippetResultOption.d.ts.map +1 -1
- package/dist/client-search/model/source.d.ts.map +1 -1
- package/dist/client-search/model/standardEntries.d.ts.map +1 -1
- package/dist/client-search/model/synonymHit.d.ts.map +1 -1
- package/dist/client-search/model/synonymHitHighlightResult.d.ts.map +1 -1
- package/dist/client-search/model/timeRange.d.ts.map +1 -1
- package/dist/client-search/model/updateApiKeyResponse.d.ts +1 -1
- package/dist/client-search/model/updateApiKeyResponse.d.ts.map +1 -1
- package/dist/client-search/model/updatedAtResponse.d.ts.map +1 -1
- package/dist/client-search/model/updatedAtWithObjectIdResponse.d.ts.map +1 -1
- package/dist/client-search/model/updatedRuleResponse.d.ts.map +1 -1
- package/dist/client-search/model/userHighlightResult.d.ts.map +1 -1
- package/dist/client-search/model/userHit.d.ts.map +1 -1
- package/dist/client-search/model/userId.d.ts.map +1 -1
- package/dist/client-search/model/value.d.ts.map +1 -1
- package/dist/client-search/src/searchClient.d.ts +65 -15
- package/dist/client-search/src/searchClient.d.ts.map +1 -1
- package/dist/lite/builds/browser.d.ts +23 -14
- package/dist/lite/builds/browser.d.ts.map +1 -1
- package/dist/lite/builds/models.d.ts +11 -8
- package/dist/lite/builds/models.d.ts.map +1 -1
- package/dist/lite/builds/node.d.ts +23 -14
- package/dist/lite/builds/node.d.ts.map +1 -1
- package/dist/lite/lite/builds/browser.d.ts +2 -2
- package/dist/lite/lite/builds/browser.d.ts.map +1 -1
- package/dist/lite/lite/builds/node.d.ts +2 -2
- package/dist/lite/lite/builds/node.d.ts.map +1 -1
- package/dist/lite/lite/model/acl.d.ts +3 -0
- package/dist/lite/lite/model/acl.d.ts.map +1 -1
- package/dist/lite/lite/model/addApiKeyResponse.d.ts +1 -1
- package/dist/lite/lite/model/addApiKeyResponse.d.ts.map +1 -1
- package/dist/lite/lite/model/apiKey.d.ts.map +1 -1
- package/dist/lite/lite/model/attributeToUpdate.d.ts +3 -0
- package/dist/lite/lite/model/attributeToUpdate.d.ts.map +1 -0
- package/dist/lite/lite/model/automaticFacetFilter.d.ts.map +1 -1
- package/dist/lite/lite/model/baseGetApiKeyResponse.d.ts +11 -0
- package/dist/lite/lite/model/baseGetApiKeyResponse.d.ts.map +1 -0
- package/dist/lite/lite/model/baseIndexSettings.d.ts.map +1 -1
- package/dist/lite/lite/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
- package/dist/lite/lite/model/baseSearchResponse.d.ts +2 -2
- package/dist/lite/lite/model/baseSearchResponse.d.ts.map +1 -1
- package/dist/lite/lite/model/browseResponse.d.ts +1 -1
- package/dist/lite/lite/model/browseResponse.d.ts.map +1 -1
- package/dist/lite/lite/model/builtInOperation.d.ts.map +1 -1
- package/dist/lite/lite/model/condition.d.ts.map +1 -1
- package/dist/lite/lite/model/consequence.d.ts.map +1 -1
- package/dist/lite/lite/model/consequenceQueryObject.d.ts.map +1 -1
- package/dist/lite/lite/model/dictionaryEntry.d.ts.map +1 -1
- package/dist/lite/lite/model/distinct.d.ts +5 -0
- package/dist/lite/lite/model/distinct.d.ts.map +1 -0
- package/dist/lite/lite/model/edit.d.ts.map +1 -1
- package/dist/lite/lite/model/facetOrdering.d.ts.map +1 -1
- package/dist/lite/lite/model/facetsStats.d.ts.map +1 -1
- package/dist/lite/lite/model/fetchedIndex.d.ts.map +1 -1
- package/dist/lite/lite/model/getApiKeyResponse.d.ts +4 -0
- package/dist/lite/lite/model/getApiKeyResponse.d.ts.map +1 -0
- package/dist/lite/lite/model/highlightResultOption.d.ts.map +1 -1
- package/dist/lite/lite/model/hit.d.ts +1 -1
- package/dist/lite/lite/model/hit.d.ts.map +1 -1
- package/dist/lite/lite/model/index.d.ts +4 -3
- package/dist/lite/lite/model/index.d.ts.map +1 -1
- package/dist/lite/lite/model/indexSettingsAsSearchParams.d.ts +2 -4
- package/dist/lite/lite/model/indexSettingsAsSearchParams.d.ts.map +1 -1
- package/dist/lite/lite/model/languages.d.ts.map +1 -1
- package/dist/lite/lite/model/listIndicesResponse.d.ts +1 -1
- package/dist/lite/lite/model/listIndicesResponse.d.ts.map +1 -1
- package/dist/lite/lite/model/matchedGeoLocation.d.ts.map +1 -1
- package/dist/lite/lite/model/params.d.ts.map +1 -1
- package/dist/lite/lite/model/personalization.d.ts.map +1 -1
- package/dist/lite/lite/model/promoteObjectID.d.ts.map +1 -1
- package/dist/lite/lite/model/promoteObjectIDs.d.ts.map +1 -1
- package/dist/lite/lite/model/rankingInfo.d.ts.map +1 -1
- package/dist/lite/lite/model/rule.d.ts.map +1 -1
- package/dist/lite/lite/model/searchForFacetsOptions.d.ts.map +1 -1
- package/dist/lite/lite/model/searchForHitsOptions.d.ts.map +1 -1
- package/dist/lite/lite/model/searchHits.d.ts +2 -2
- package/dist/lite/lite/model/searchHits.d.ts.map +1 -1
- package/dist/lite/lite/model/searchMethodParams.d.ts.map +1 -1
- package/dist/lite/lite/model/searchResponse.d.ts +1 -1
- package/dist/lite/lite/model/searchResponse.d.ts.map +1 -1
- package/dist/lite/lite/model/searchResponses.d.ts +1 -1
- package/dist/lite/lite/model/searchResponses.d.ts.map +1 -1
- package/dist/lite/lite/model/searchSynonymsResponse.d.ts.map +1 -1
- package/dist/lite/lite/model/snippetResultOption.d.ts.map +1 -1
- package/dist/lite/lite/model/source.d.ts.map +1 -1
- package/dist/lite/lite/model/standardEntries.d.ts.map +1 -1
- package/dist/lite/lite/model/synonymHit.d.ts.map +1 -1
- package/dist/lite/lite/model/synonymHitHighlightResult.d.ts.map +1 -1
- package/dist/lite/lite/model/timeRange.d.ts.map +1 -1
- package/dist/lite/lite/model/updatedRuleResponse.d.ts.map +1 -1
- package/dist/lite/lite/model/userId.d.ts.map +1 -1
- package/dist/lite/lite/model/value.d.ts.map +1 -1
- package/dist/lite/lite/src/liteClient.d.ts +12 -1
- package/dist/lite/lite/src/liteClient.d.ts.map +1 -1
- package/dist/lite/lite.cjs.js +14 -1
- package/dist/lite/lite.esm.browser.js +14 -1
- package/dist/lite/lite.esm.node.js +14 -1
- package/dist/lite/lite.umd.js +2 -2
- package/lite/builds/browser.ts +2 -2
- package/lite/builds/node.ts +2 -2
- package/lite/model/acl.ts +3 -0
- package/lite/model/addApiKeyResponse.ts +2 -1
- package/lite/model/apiKey.ts +7 -0
- package/lite/model/{attributeOrBuiltInOperation.ts → attributeToUpdate.ts} +1 -1
- package/lite/model/automaticFacetFilter.ts +2 -0
- package/lite/model/baseGetApiKeyResponse.ts +13 -0
- package/lite/model/baseIndexSettings.ts +13 -0
- package/lite/model/baseSearchParamsWithoutQuery.ts +32 -0
- package/lite/model/baseSearchResponse.ts +26 -2
- package/lite/model/browseResponse.ts +1 -1
- package/lite/model/builtInOperation.ts +1 -0
- package/lite/model/condition.ts +3 -0
- package/lite/model/consequence.ts +4 -0
- package/lite/model/consequenceQueryObject.ts +1 -0
- package/lite/model/dictionaryEntry.ts +5 -0
- package/lite/model/{createdAtObject.ts → distinct.ts} +4 -6
- package/lite/model/edit.ts +2 -0
- package/lite/model/facetOrdering.ts +1 -0
- package/lite/model/facetsStats.ts +3 -0
- package/lite/model/fetchedIndex.ts +10 -0
- package/lite/model/{key.ts → getApiKeyResponse.ts} +2 -2
- package/lite/model/highlightResultOption.ts +3 -0
- package/lite/model/hit.ts +5 -1
- package/lite/model/index.ts +4 -3
- package/lite/model/indexSettingsAsSearchParams.ts +43 -4
- package/lite/model/languages.ts +2 -0
- package/lite/model/listIndicesResponse.ts +2 -1
- package/lite/model/matchedGeoLocation.ts +2 -0
- package/lite/model/params.ts +3 -0
- package/lite/model/personalization.ts +2 -0
- package/lite/model/promoteObjectID.ts +1 -0
- package/lite/model/promoteObjectIDs.ts +1 -0
- package/lite/model/rankingInfo.ts +12 -0
- package/lite/model/rule.ts +5 -0
- package/lite/model/searchForFacetsOptions.ts +4 -0
- package/lite/model/searchForHitsOptions.ts +1 -0
- package/lite/model/searchHits.ts +2 -2
- package/lite/model/searchMethodParams.ts +1 -0
- package/lite/model/searchResponse.ts +2 -1
- package/lite/model/searchResponses.ts +1 -1
- package/lite/model/searchSynonymsResponse.ts +1 -0
- package/lite/model/snippetResultOption.ts +1 -0
- package/lite/model/source.ts +1 -0
- package/lite/model/standardEntries.ts +2 -0
- package/lite/model/synonymHit.ts +8 -0
- package/lite/model/synonymHitHighlightResult.ts +1 -0
- package/lite/model/timeRange.ts +1 -0
- package/lite/model/updatedRuleResponse.ts +2 -0
- package/lite/model/userId.ts +3 -0
- package/lite/model/value.ts +1 -0
- package/lite/src/liteClient.ts +22 -1
- package/package.json +9 -9
- package/dist/algoliasearch/lite/model/attributeOrBuiltInOperation.d.ts +0 -3
- package/dist/algoliasearch/lite/model/attributeOrBuiltInOperation.d.ts.map +0 -1
- package/dist/algoliasearch/lite/model/createdAtObject.d.ts +0 -7
- package/dist/algoliasearch/lite/model/createdAtObject.d.ts.map +0 -1
- package/dist/algoliasearch/lite/model/key.d.ts +0 -4
- package/dist/algoliasearch/lite/model/key.d.ts.map +0 -1
- package/dist/client-search/model/attributeOrBuiltInOperation.d.ts +0 -3
- package/dist/client-search/model/attributeOrBuiltInOperation.d.ts.map +0 -1
- package/dist/client-search/model/batchOperation.d.ts.map +0 -1
- package/dist/client-search/model/createdAtObject.d.ts +0 -7
- package/dist/client-search/model/createdAtObject.d.ts.map +0 -1
- package/dist/client-search/model/key.d.ts +0 -4
- package/dist/client-search/model/key.d.ts.map +0 -1
- package/dist/client-search/model/multipleBatchOperation.d.ts.map +0 -1
- package/dist/client-search/model/multipleGetObjectsParams.d.ts.map +0 -1
- package/dist/lite/lite/model/attributeOrBuiltInOperation.d.ts +0 -3
- package/dist/lite/lite/model/attributeOrBuiltInOperation.d.ts.map +0 -1
- package/dist/lite/lite/model/createdAtObject.d.ts +0 -7
- package/dist/lite/lite/model/createdAtObject.d.ts.map +0 -1
- package/dist/lite/lite/model/key.d.ts +0 -4
- package/dist/lite/lite/model/key.d.ts.map +0 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"saveObjectResponse.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/saveObjectResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,kBAAkB,GAAG;IAC/B,SAAS,
|
|
1
|
+
{"version":3,"file":"saveObjectResponse.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/saveObjectResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,kBAAkB,GAAG;IAC/B,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"saveSynonymResponse.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/saveSynonymResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"saveSynonymResponse.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/saveSynonymResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"searchDictionaryEntriesParams.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/searchDictionaryEntriesParams.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,6BAA6B,GAAG;IAC1C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"searchDictionaryEntriesParams.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/searchDictionaryEntriesParams.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,6BAA6B,GAAG;IAC1C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"searchForFacetValuesRequest.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/searchForFacetValuesRequest.ts"],"names":[],"mappings":"AAEA,oBAAY,2BAA2B,GAAG;IACxC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"searchForFacetValuesRequest.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/searchForFacetValuesRequest.ts"],"names":[],"mappings":"AAEA,oBAAY,2BAA2B,GAAG;IACxC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"searchForFacetsOptions.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/searchForFacetsOptions.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,sBAAsB,GAAG;IACnC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"searchForFacetsOptions.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/searchForFacetsOptions.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,sBAAsB,GAAG;IACnC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,IAAI,EAAE,eAAe,CAAC;CACvB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"searchForHitsOptions.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/searchForHitsOptions.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,oBAAY,oBAAoB,GAAG;IACjC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"searchForHitsOptions.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/searchForHitsOptions.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,oBAAY,oBAAoB,GAAG;IACjC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,IAAI,CAAC,EAAE,iBAAiB,CAAC;CAC1B,GAAG;IAAE,KAAK,CAAC,EAAE,KAAK,CAAC;IAAC,YAAY,CAAC,EAAE,KAAK,CAAC;IAAC,UAAU,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"searchHits.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/searchHits.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAEjC,oBAAY,UAAU,CAAC,CAAC,IAAI;
|
|
1
|
+
{"version":3,"file":"searchHits.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/searchHits.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAEjC,oBAAY,UAAU,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI;IAChD,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;CACrB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"searchMethodParams.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/searchMethodParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,oBAAY,kBAAkB,GAAG;IAC/B,QAAQ,EAAE,WAAW,EAAE,CAAC;
|
|
1
|
+
{"version":3,"file":"searchMethodParams.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/searchMethodParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,oBAAY,kBAAkB,GAAG;IAC/B,QAAQ,EAAE,WAAW,EAAE,CAAC;IAExB,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC3B,CAAC"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
import type { BaseSearchResponse } from './baseSearchResponse';
|
|
2
2
|
import type { SearchHits } from './searchHits';
|
|
3
|
-
export declare type SearchResponse<T
|
|
3
|
+
export declare type SearchResponse<T = Record<string, any>> = BaseSearchResponse & SearchHits<T>;
|
|
4
4
|
//# sourceMappingURL=searchResponse.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"searchResponse.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/searchResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,oBAAY,cAAc,CAAC,CAAC,IAAI,kBAAkB,
|
|
1
|
+
{"version":3,"file":"searchResponse.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/searchResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,oBAAY,cAAc,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,kBAAkB,GACtE,UAAU,CAAC,CAAC,CAAC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"searchResponses.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/searchResponses.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,oBAAY,eAAe,CAAC,CAAC,IAAI;
|
|
1
|
+
{"version":3,"file":"searchResponses.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/searchResponses.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,oBAAY,eAAe,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI;IACrD,OAAO,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;CACnC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"searchRulesParams.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/searchRulesParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;GAEG;AACH,oBAAY,iBAAiB,GAAG;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"searchRulesParams.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/searchRulesParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;GAEG;AACH,oBAAY,iBAAiB,GAAG;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;CAC7C,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"searchRulesResponse.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/searchRulesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,IAAI,EAAE,IAAI,EAAE,CAAC;
|
|
1
|
+
{"version":3,"file":"searchRulesResponse.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/searchRulesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,IAAI,EAAE,IAAI,EAAE,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"searchSynonymsResponse.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/searchSynonymsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,oBAAY,sBAAsB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IACzD;;OAEG;IACH,IAAI,EAAE,UAAU,EAAE,CAAC;
|
|
1
|
+
{"version":3,"file":"searchSynonymsResponse.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/searchSynonymsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,oBAAY,sBAAsB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IACzD;;OAEG;IACH,IAAI,EAAE,UAAU,EAAE,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"searchUserIdsParams.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/searchUserIdsParams.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"searchUserIdsParams.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/searchUserIdsParams.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"searchUserIdsResponse.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/searchUserIdsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;GAEG;AACH,oBAAY,qBAAqB,GAAG;IAClC;;OAEG;IACH,IAAI,EAAE,OAAO,EAAE,CAAC;
|
|
1
|
+
{"version":3,"file":"searchUserIdsResponse.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/searchUserIdsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;GAEG;AACH,oBAAY,qBAAqB,GAAG;IAClC;;OAEG;IACH,IAAI,EAAE,OAAO,EAAE,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"snippetResultOption.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/snippetResultOption.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C;;GAEG;AACH,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"snippetResultOption.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/snippetResultOption.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C;;GAEG;AACH,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,EAAE,UAAU,CAAC;CACxB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"source.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/source.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,MAAM,GAAG;IACnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"source.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/source.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,MAAM,GAAG;IACnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"standardEntries.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/standardEntries.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,eAAe,GAAG;IAC5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;
|
|
1
|
+
{"version":3,"file":"standardEntries.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/standardEntries.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,eAAe,GAAG;IAC5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CAC5C,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"synonymHit.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/synonymHit.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAC7E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD;;GAEG;AACH,oBAAY,UAAU,GAAG;IACvB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"synonymHit.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/synonymHit.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAC7E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD;;GAEG;AACH,oBAAY,UAAU,GAAG;IACvB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,IAAI,EAAE,WAAW,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB,gBAAgB,CAAC,EAAE,yBAAyB,CAAC;CAC9C,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
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;
|
|
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"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"timeRange.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/timeRange.ts"],"names":[],"mappings":"AAEA,oBAAY,SAAS,GAAG;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"timeRange.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/timeRange.ts"],"names":[],"mappings":"AAEA,oBAAY,SAAS,GAAG;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"updateApiKeyResponse.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/updateApiKeyResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,oBAAoB,GAAG;IACjC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"updateApiKeyResponse.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/updateApiKeyResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,oBAAoB,GAAG;IACjC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"updatedAtResponse.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/updatedAtResponse.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,iBAAiB,GAAG;IAC9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"updatedAtResponse.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/updatedAtResponse.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,iBAAiB,GAAG;IAC9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"updatedAtWithObjectIdResponse.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/updatedAtWithObjectIdResponse.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,6BAA6B,GAAG;IAC1C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"updatedAtWithObjectIdResponse.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/updatedAtWithObjectIdResponse.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,6BAA6B,GAAG;IAC1C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"updatedRuleResponse.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/updatedRuleResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"updatedRuleResponse.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/updatedRuleResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"userHighlightResult.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/userHighlightResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"userHighlightResult.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/userHighlightResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAExC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC9C,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"userHit.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/userHit.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,oBAAY,OAAO,GAAG;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"userHit.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/userHit.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,oBAAY,OAAO,GAAG;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,gBAAgB,EAAE,mBAAmB,CAAC;CACvC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"userId.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/userId.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,MAAM,GAAG;IACnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"userId.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/userId.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,MAAM,GAAG;IACnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"value.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/value.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,KAAK,GAAG;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;
|
|
1
|
+
{"version":3,"file":"value.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/value.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,KAAK,GAAG;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjB,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC,CAAC"}
|
|
@@ -4,12 +4,13 @@ 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 { WaitForTaskOptions, WaitForApiKeyOptions, AddOrUpdateObjectProps, AssignUserIdProps, BatchProps, BatchAssignUserIdsProps, BatchDictionaryEntriesProps, BrowseProps, ClearAllSynonymsProps, ClearObjectsProps, ClearRulesProps, DelProps, DeleteApiKeyProps, DeleteByProps, DeleteIndexProps, DeleteObjectProps, DeleteRuleProps, DeleteSourceProps, DeleteSynonymProps, GetProps, GetApiKeyProps, GetLogsProps, GetObjectProps, GetRuleProps, GetSettingsProps, GetSynonymProps, GetTaskProps, GetUserIdProps, HasPendingMappingsProps, ListIndicesProps, ListUserIdsProps, OperationIndexProps, PartialUpdateObjectProps, PostProps, PutProps, RemoveUserIdProps, ReplaceSourcesProps, RestoreApiKeyProps, SaveObjectProps, SaveRuleProps, SaveRulesProps, SaveSynonymProps, SaveSynonymsProps, LegacySearchMethodProps, SearchDictionaryEntriesProps, SearchForFacetValuesProps, SearchRulesProps, SearchSingleIndexProps, SearchSynonymsProps, SetSettingsProps, UpdateApiKeyProps } from '../model/clientMethodProps';
|
|
7
|
+
import type { BrowseOptions, WaitForTaskOptions, WaitForApiKeyOptions, AddOrUpdateObjectProps, AssignUserIdProps, BatchProps, BatchAssignUserIdsProps, BatchDictionaryEntriesProps, BrowseProps, ClearAllSynonymsProps, ClearObjectsProps, ClearRulesProps, DelProps, DeleteApiKeyProps, DeleteByProps, DeleteIndexProps, DeleteObjectProps, DeleteRuleProps, DeleteSourceProps, DeleteSynonymProps, GetProps, GetApiKeyProps, GetLogsProps, GetObjectProps, GetRuleProps, GetSettingsProps, GetSynonymProps, GetTaskProps, GetUserIdProps, HasPendingMappingsProps, ListIndicesProps, ListUserIdsProps, OperationIndexProps, PartialUpdateObjectProps, PostProps, PutProps, 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';
|
|
11
11
|
import type { DeletedAtResponse } from '../model/deletedAtResponse';
|
|
12
12
|
import type { DictionarySettingsParams } from '../model/dictionarySettingsParams';
|
|
13
|
+
import type { GetApiKeyResponse } from '../model/getApiKeyResponse';
|
|
13
14
|
import type { GetDictionarySettingsResponse } from '../model/getDictionarySettingsResponse';
|
|
14
15
|
import type { GetLogsResponse } from '../model/getLogsResponse';
|
|
15
16
|
import type { GetObjectsParams } from '../model/getObjectsParams';
|
|
@@ -18,7 +19,6 @@ import type { GetTaskResponse } from '../model/getTaskResponse';
|
|
|
18
19
|
import type { GetTopUserIdsResponse } from '../model/getTopUserIdsResponse';
|
|
19
20
|
import type { HasPendingMappingsResponse } from '../model/hasPendingMappingsResponse';
|
|
20
21
|
import type { IndexSettings } from '../model/indexSettings';
|
|
21
|
-
import type { Key } from '../model/key';
|
|
22
22
|
import type { Languages } from '../model/languages';
|
|
23
23
|
import type { ListApiKeysResponse } from '../model/listApiKeysResponse';
|
|
24
24
|
import type { ListClustersResponse } from '../model/listClustersResponse';
|
|
@@ -45,9 +45,17 @@ 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.4";
|
|
49
49
|
export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
|
|
50
50
|
transporter: import("@algolia/client-common").Transporter;
|
|
51
|
+
/**
|
|
52
|
+
* The `appId` currently in use.
|
|
53
|
+
*/
|
|
54
|
+
appId: string;
|
|
55
|
+
/**
|
|
56
|
+
* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
|
|
57
|
+
*/
|
|
58
|
+
clearCache(): Promise<void>;
|
|
51
59
|
/**
|
|
52
60
|
* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
|
|
53
61
|
*/
|
|
@@ -60,26 +68,65 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
60
68
|
*/
|
|
61
69
|
addAlgoliaAgent(segment: string, version?: string): void;
|
|
62
70
|
/**
|
|
63
|
-
* Helper: Wait for a task to
|
|
71
|
+
* Helper: Wait for a task to be published (completed) for a given `indexName` and `taskID`.
|
|
64
72
|
*
|
|
65
|
-
* @summary
|
|
73
|
+
* @summary Helper method that waits for a task to be published (completed).
|
|
66
74
|
* @param waitForTaskOptions - The waitForTaskOptions object.
|
|
67
75
|
* @param waitForTaskOptions.indexName - The `indexName` where the operation was performed.
|
|
68
76
|
* @param waitForTaskOptions.taskID - The `taskID` returned in the method response.
|
|
77
|
+
* @param waitForTaskOptions.maxRetries - The maximum number of retries. 50 by default.
|
|
78
|
+
* @param waitForTaskOptions.timeout - The function to decide how long to wait between retries.
|
|
69
79
|
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
|
|
70
80
|
*/
|
|
71
|
-
waitForTask({ indexName, taskID,
|
|
81
|
+
waitForTask({ indexName, taskID, maxRetries, timeout, }: WaitForTaskOptions, requestOptions?: RequestOptions): Promise<GetTaskResponse>;
|
|
72
82
|
/**
|
|
73
83
|
* Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
|
|
74
84
|
*
|
|
75
|
-
* @summary
|
|
85
|
+
* @summary Helper method that waits for an API key task to be processed.
|
|
76
86
|
* @param waitForApiKeyOptions - The waitForApiKeyOptions object.
|
|
77
87
|
* @param waitForApiKeyOptions.operation - The `operation` that was done on a `key`.
|
|
78
88
|
* @param waitForApiKeyOptions.key - The `key` that has been added, deleted or updated.
|
|
79
89
|
* @param waitForApiKeyOptions.apiKey - Necessary to know if an `update` operation has been processed, compare fields of the response with it.
|
|
90
|
+
* @param waitForApiKeyOptions.maxRetries - The maximum number of retries. 50 by default.
|
|
91
|
+
* @param waitForApiKeyOptions.timeout - The function to decide how long to wait between retries.
|
|
80
92
|
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getApikey` method and merged with the transporter requestOptions.
|
|
81
93
|
*/
|
|
82
|
-
waitForApiKey({ operation, key, apiKey,
|
|
94
|
+
waitForApiKey({ operation, key, apiKey, maxRetries, timeout, }: WaitForApiKeyOptions, requestOptions?: RequestOptions): Promise<ApiError | GetApiKeyResponse>;
|
|
95
|
+
/**
|
|
96
|
+
* Helper: Iterate on the `browse` method of the client to allow aggregating objects of an index.
|
|
97
|
+
*
|
|
98
|
+
* @summary Helper method that iterates on the `browse` method.
|
|
99
|
+
* @param browseObjects - The browseObjects object.
|
|
100
|
+
* @param browseObjects.indexName - The index in which to perform the request.
|
|
101
|
+
* @param browseObjects.browseRequest - The `browse` method parameters.
|
|
102
|
+
* @param browseObjects.validate - The validator function. It receive the resolved return of the API call.
|
|
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
|
+
* @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
|
+
*/
|
|
106
|
+
browseObjects<T>({ indexName, browseRequest, ...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
|
+
/**
|
|
108
|
+
* Helper: Iterate on the `searchRules` method of the client to allow aggregating rules of an index.
|
|
109
|
+
*
|
|
110
|
+
* @summary Helper method that iterates on the `searchRules` method.
|
|
111
|
+
* @param browseObjects - The browseObjects object.
|
|
112
|
+
* @param browseObjects.indexName - The index in which to perform the request.
|
|
113
|
+
* @param browseObjects.searchRulesParams - The `searchRules` method parameters.
|
|
114
|
+
* @param browseObjects.validate - The validator function. It receive the resolved return of the API call.
|
|
115
|
+
* @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`.
|
|
116
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `searchRules` method and merged with the transporter requestOptions.
|
|
117
|
+
*/
|
|
118
|
+
browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: BrowseOptions<SearchRulesResponse> & SearchRulesProps, requestOptions?: RequestOptions): Promise<SearchRulesResponse>;
|
|
119
|
+
/**
|
|
120
|
+
* Helper: Iterate on the `searchSynonyms` method of the client to allow aggregating rules of an index.
|
|
121
|
+
*
|
|
122
|
+
* @summary Helper method that iterates on the `searchSynonyms` method.
|
|
123
|
+
* @param browseObjects - The browseObjects object.
|
|
124
|
+
* @param browseObjects.indexName - The index in which to perform the request.
|
|
125
|
+
* @param browseObjects.validate - The validator function. It receive the resolved return of the API call.
|
|
126
|
+
* @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`.
|
|
127
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `searchSynonyms` method and merged with the transporter requestOptions.
|
|
128
|
+
*/
|
|
129
|
+
browseSynonyms({ indexName, validate, aggregator, ...browseSynonymsOptions }: BrowseOptions<SearchSynonymsResponse> & SearchSynonymsProps, requestOptions?: RequestOptions): Promise<SearchSynonymsResponse>;
|
|
83
130
|
/**
|
|
84
131
|
* Add a new API Key with specific permissions/restrictions.
|
|
85
132
|
*
|
|
@@ -156,7 +203,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
156
203
|
* @param browse.browseRequest - The browseRequest object.
|
|
157
204
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
158
205
|
*/
|
|
159
|
-
browse<
|
|
206
|
+
browse<T_1>({ indexName, browseRequest }: BrowseProps, requestOptions?: RequestOptions): Promise<BrowseResponse<T_1>>;
|
|
160
207
|
/**
|
|
161
208
|
* Remove all synonyms from an index.
|
|
162
209
|
*
|
|
@@ -283,7 +330,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
283
330
|
* @param getApiKey.key - API Key string.
|
|
284
331
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
285
332
|
*/
|
|
286
|
-
getApiKey({ key }: GetApiKeyProps, requestOptions?: RequestOptions): Promise<
|
|
333
|
+
getApiKey({ key }: GetApiKeyProps, requestOptions?: RequestOptions): Promise<GetApiKeyResponse>;
|
|
287
334
|
/**
|
|
288
335
|
* List dictionaries supported per language.
|
|
289
336
|
*
|
|
@@ -328,7 +375,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
328
375
|
* @param getObjectsParams - The Algolia object.
|
|
329
376
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
330
377
|
*/
|
|
331
|
-
getObjects(getObjectsParams: GetObjectsParams, requestOptions?: RequestOptions): Promise<GetObjectsResponse
|
|
378
|
+
getObjects<T_2>(getObjectsParams: GetObjectsParams, requestOptions?: RequestOptions): Promise<GetObjectsResponse<T_2>>;
|
|
332
379
|
/**
|
|
333
380
|
* Retrieve the Rule with the specified objectID.
|
|
334
381
|
*
|
|
@@ -458,11 +505,11 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
458
505
|
* @param partialUpdateObject - The partialUpdateObject object.
|
|
459
506
|
* @param partialUpdateObject.indexName - The index in which to perform the request.
|
|
460
507
|
* @param partialUpdateObject.objectID - Unique identifier of an object.
|
|
461
|
-
* @param partialUpdateObject.
|
|
508
|
+
* @param partialUpdateObject.attributeToUpdate - List of attributes to update.
|
|
462
509
|
* @param partialUpdateObject.createIfNotExists - Creates the record if it does not exist yet.
|
|
463
510
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
464
511
|
*/
|
|
465
|
-
partialUpdateObject({ indexName, objectID,
|
|
512
|
+
partialUpdateObject({ indexName, objectID, attributeToUpdate, createIfNotExists, }: PartialUpdateObjectProps, requestOptions?: RequestOptions): Promise<UpdatedAtWithObjectIdResponse>;
|
|
466
513
|
/**
|
|
467
514
|
* This method allow you to send requests to the Algolia REST API.
|
|
468
515
|
*
|
|
@@ -577,7 +624,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
577
624
|
* @param searchMethodParams - The `search` requests and strategy.
|
|
578
625
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
579
626
|
*/
|
|
580
|
-
search<
|
|
627
|
+
search<T_3>(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: RequestOptions): Promise<SearchResponses<T_3>>;
|
|
581
628
|
/**
|
|
582
629
|
* Search the dictionary entries.
|
|
583
630
|
*
|
|
@@ -618,7 +665,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
618
665
|
* @param searchSingleIndex.searchParams - The searchParams object.
|
|
619
666
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
620
667
|
*/
|
|
621
|
-
searchSingleIndex<
|
|
668
|
+
searchSingleIndex<T_4>({ indexName, searchParams }: SearchSingleIndexProps, requestOptions?: RequestOptions): Promise<SearchResponse<T_4>>;
|
|
622
669
|
/**
|
|
623
670
|
* Search or browse all synonyms, optionally filtering them by type.
|
|
624
671
|
*
|
|
@@ -670,5 +717,8 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
670
717
|
*/
|
|
671
718
|
updateApiKey({ key, apiKey }: UpdateApiKeyProps, requestOptions?: RequestOptions): Promise<UpdateApiKeyResponse>;
|
|
672
719
|
};
|
|
720
|
+
/**
|
|
721
|
+
* The client type.
|
|
722
|
+
*/
|
|
673
723
|
export declare type SearchClient = ReturnType<typeof createSearchClient>;
|
|
674
724
|
//# sourceMappingURL=searchClient.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"searchClient.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/src/searchClient.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEd,QAAQ,
|
|
1
|
+
{"version":3,"file":"searchClient.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/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,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,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;2TAOgB,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;IAsB7B;;;;;;;;OAQG;yDAEuC,iBAAiB,mBACxC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAsC7B;;;;;;;;OAQG;2CAEgC,UAAU,mBAC1B,cAAc,GAC9B,QAAQ,aAAa,CAAC;IA+BzB;;;;;;;;OAQG;qEAE6C,uBAAuB,mBACpD,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA2C7B;;;;;;;;OAQG;8EAKE,2BAA2B,mBACb,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAqC7B;;;;;;;;OAQG;8CAE6B,WAAW,mBACxB,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;0CAE4B,aAAa,mBACzB,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;iDAEoC,YAAY,mBAChC,cAAc,GAC9B,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;wCAEgB,uBAAuB,mBACvB,cAAc,GAC9B,QAAQ,0BAA0B,CAAC;IAmBtC;;;;;OAKG;iCAC0B,cAAc,GAAG,QAAQ,mBAAmB,CAAC;IAe1E;;;;;OAKG;kCAEgB,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAehC;;;;;;;OAOG;0BAES,gBAAgB,mBACT,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IAmB/B;;;;;;;;OAQG;uCAEsB,gBAAgB,mBACtB,cAAc,GAC9B,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;wFAOE,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;2EAOE,cAAc,mBACA,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAuC7B;;;;;;;;;;OAUG;wEAEuD,gBAAgB,mBACvD,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IA8C/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,oBAAY,YAAY,GAAG,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC"}
|
|
@@ -1,19 +1,28 @@
|
|
|
1
1
|
import type { Region as AbtestingRegion, AbtestingClient } from '@algolia/client-abtesting/src/abtestingClient';
|
|
2
2
|
import type { Region as AnalyticsRegion, AnalyticsClient } from '@algolia/client-analytics/src/analyticsClient';
|
|
3
|
+
import type { ClientOptions } from '@algolia/client-common';
|
|
3
4
|
import type { Region as PersonalizationRegion, PersonalizationClient } from '@algolia/client-personalization/src/personalizationClient';
|
|
4
|
-
import type {
|
|
5
|
+
import type { InitClientOptions, InitClientRegion } from './models';
|
|
5
6
|
export * from './models';
|
|
6
|
-
export declare const apiClientVersion = "5.0.0-alpha.
|
|
7
|
+
export declare const apiClientVersion = "5.0.0-alpha.4";
|
|
8
|
+
/**
|
|
9
|
+
* The client type.
|
|
10
|
+
*/
|
|
7
11
|
export declare type Algoliasearch = ReturnType<typeof algoliasearch>;
|
|
8
|
-
export declare function algoliasearch(appId: string, apiKey: string, options?:
|
|
12
|
+
export declare function algoliasearch(appId: string, apiKey: string, options?: ClientOptions): {
|
|
9
13
|
_ua: string;
|
|
10
|
-
initAnalytics: (initOptions?:
|
|
11
|
-
initPersonalization: (initOptions:
|
|
12
|
-
initAbtesting: (initOptions?:
|
|
14
|
+
initAnalytics: (initOptions?: InitClientOptions & InitClientRegion<AnalyticsRegion>) => AnalyticsClient;
|
|
15
|
+
initPersonalization: (initOptions: InitClientOptions & Required<InitClientRegion<PersonalizationRegion>>) => PersonalizationClient;
|
|
16
|
+
initAbtesting: (initOptions?: InitClientOptions & InitClientRegion<AbtestingRegion>) => AbtestingClient;
|
|
13
17
|
transporter: import("@algolia/client-common").Transporter;
|
|
18
|
+
appId: string;
|
|
19
|
+
clearCache(): Promise<void>;
|
|
14
20
|
addAlgoliaAgent(segment: string, version?: string | undefined): void;
|
|
15
|
-
waitForTask({ indexName, taskID,
|
|
16
|
-
waitForApiKey({ operation, key, apiKey,
|
|
21
|
+
waitForTask({ indexName, taskID, maxRetries, timeout, }: import("@algolia/client-search/model/clientMethodProps").WaitForTaskOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/getTaskResponse").GetTaskResponse>;
|
|
22
|
+
waitForApiKey({ operation, key, apiKey, maxRetries, timeout, }: import("@algolia/client-search/model/clientMethodProps").WaitForApiKeyOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/getApiKeyResponse").GetApiKeyResponse | import("@algolia/client-common").ApiError>;
|
|
23
|
+
browseObjects<T>({ indexName, browseRequest, ...browseObjectsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/browseResponse").BrowseResponse<T>>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/browseResponse").BrowseResponse<T>>, "aggregator">> & import("@algolia/client-search/model/clientMethodProps").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/browseResponse").BrowseResponse<T>>;
|
|
24
|
+
browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse>, "aggregator">> & import("@algolia/client-search/model/clientMethodProps").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse>;
|
|
25
|
+
browseSynonyms({ indexName, validate, aggregator, ...browseSynonymsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>, "aggregator">> & import("@algolia/client-search/model/clientMethodProps").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>;
|
|
17
26
|
addApiKey(apiKey: import("@algolia/client-search/model/apiKey").ApiKey, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/addApiKeyResponse").AddApiKeyResponse>;
|
|
18
27
|
addOrUpdateObject({ indexName, objectID, body }: import("@algolia/client-search/model/clientMethodProps").AddOrUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtWithObjectIdResponse").UpdatedAtWithObjectIdResponse>;
|
|
19
28
|
appendSource(source: import("@algolia/client-search/model/source").Source, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/createdAtResponse").CreatedAtResponse>;
|
|
@@ -21,7 +30,7 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
|
|
|
21
30
|
batch({ indexName, batchWriteParams }: import("@algolia/client-search/model/clientMethodProps").BatchProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse>;
|
|
22
31
|
batchAssignUserIds({ xAlgoliaUserID, batchAssignUserIdsParams }: import("@algolia/client-search/model/clientMethodProps").BatchAssignUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/createdAtResponse").CreatedAtResponse>;
|
|
23
32
|
batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams, }: import("@algolia/client-search/model/clientMethodProps").BatchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
24
|
-
browse<
|
|
33
|
+
browse<T_1>({ indexName, browseRequest }: import("@algolia/client-search/model/clientMethodProps").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/browseResponse").BrowseResponse<T_1>>;
|
|
25
34
|
clearAllSynonyms({ indexName, forwardToReplicas }: import("@algolia/client-search/model/clientMethodProps").ClearAllSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
26
35
|
clearObjects({ indexName }: import("@algolia/client-search/model/clientMethodProps").ClearObjectsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
27
36
|
clearRules({ indexName, forwardToReplicas }: import("@algolia/client-search/model/clientMethodProps").ClearRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
@@ -34,12 +43,12 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
|
|
|
34
43
|
deleteSource({ source }: import("@algolia/client-search/model/clientMethodProps").DeleteSourceProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/deleteSourceResponse").DeleteSourceResponse>;
|
|
35
44
|
deleteSynonym({ indexName, objectID, forwardToReplicas }: import("@algolia/client-search/model/clientMethodProps").DeleteSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/deletedAtResponse").DeletedAtResponse>;
|
|
36
45
|
get({ path, parameters }: import("@algolia/client-search/model/clientMethodProps").GetProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
|
|
37
|
-
getApiKey({ key }: import("@algolia/client-search/model/clientMethodProps").GetApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/
|
|
46
|
+
getApiKey({ key }: import("@algolia/client-search/model/clientMethodProps").GetApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/getApiKeyResponse").GetApiKeyResponse>;
|
|
38
47
|
getDictionaryLanguages(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, import("@algolia/client-search/model/languages").Languages>>;
|
|
39
48
|
getDictionarySettings(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/getDictionarySettingsResponse").GetDictionarySettingsResponse>;
|
|
40
49
|
getLogs({ offset, length, indexName, type }: import("@algolia/client-search/model/clientMethodProps").GetLogsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/getLogsResponse").GetLogsResponse>;
|
|
41
50
|
getObject({ indexName, objectID, attributesToRetrieve }: import("@algolia/client-search/model/clientMethodProps").GetObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, string>>;
|
|
42
|
-
getObjects(getObjectsParams: import("@algolia/client-search/model/getObjectsParams").GetObjectsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/getObjectsResponse").GetObjectsResponse
|
|
51
|
+
getObjects<T_2>(getObjectsParams: import("@algolia/client-search/model/getObjectsParams").GetObjectsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/getObjectsResponse").GetObjectsResponse<T_2>>;
|
|
43
52
|
getRule({ indexName, objectID }: import("@algolia/client-search/model/clientMethodProps").GetRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/rule").Rule>;
|
|
44
53
|
getSettings({ indexName }: import("@algolia/client-search/model/clientMethodProps").GetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/indexSettings").IndexSettings>;
|
|
45
54
|
getSources(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/source").Source[]>;
|
|
@@ -54,7 +63,7 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
|
|
|
54
63
|
listUserIds({ page, hitsPerPage }: import("@algolia/client-search/model/clientMethodProps").ListUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/listUserIdsResponse").ListUserIdsResponse>;
|
|
55
64
|
multipleBatch(batchParams: import("@algolia/client-search/model/batchParams").BatchParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/multipleBatchResponse").MultipleBatchResponse>;
|
|
56
65
|
operationIndex({ indexName, operationIndexParams }: import("@algolia/client-search/model/clientMethodProps").OperationIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
57
|
-
partialUpdateObject({ indexName, objectID,
|
|
66
|
+
partialUpdateObject({ indexName, objectID, attributeToUpdate, createIfNotExists, }: import("@algolia/client-search/model/clientMethodProps").PartialUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtWithObjectIdResponse").UpdatedAtWithObjectIdResponse>;
|
|
58
67
|
post({ path, parameters, body }: import("@algolia/client-search/model/clientMethodProps").PostProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
|
|
59
68
|
put({ path, parameters, body }: import("@algolia/client-search/model/clientMethodProps").PutProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
|
|
60
69
|
removeUserId({ userID }: import("@algolia/client-search/model/clientMethodProps").RemoveUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/removeUserIdResponse").RemoveUserIdResponse>;
|
|
@@ -65,11 +74,11 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
|
|
|
65
74
|
saveRules({ indexName, rule, forwardToReplicas, clearExistingRules, }: import("@algolia/client-search/model/clientMethodProps").SaveRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
66
75
|
saveSynonym({ indexName, objectID, synonymHit, forwardToReplicas }: import("@algolia/client-search/model/clientMethodProps").SaveSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/saveSynonymResponse").SaveSynonymResponse>;
|
|
67
76
|
saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms, }: import("@algolia/client-search/model/clientMethodProps").SaveSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
68
|
-
search<
|
|
77
|
+
search<T_3>(searchMethodParams: import("@algolia/client-search/model/clientMethodProps").LegacySearchMethodProps | import("@algolia/client-search/model/searchMethodParams").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchResponses").SearchResponses<T_3>>;
|
|
69
78
|
searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams, }: import("@algolia/client-search/model/clientMethodProps").SearchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
70
79
|
searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest, }: import("@algolia/client-search/model/clientMethodProps").SearchForFacetValuesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchForFacetValuesResponse").SearchForFacetValuesResponse>;
|
|
71
80
|
searchRules({ indexName, searchRulesParams }: import("@algolia/client-search/model/clientMethodProps").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse>;
|
|
72
|
-
searchSingleIndex<
|
|
81
|
+
searchSingleIndex<T_4>({ indexName, searchParams }: import("@algolia/client-search/model/clientMethodProps").SearchSingleIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchResponse").SearchResponse<T_4>>;
|
|
73
82
|
searchSynonyms({ indexName, type, page, hitsPerPage, searchSynonymsParams, }: import("@algolia/client-search/model/clientMethodProps").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>;
|
|
74
83
|
searchUserIds(searchUserIdsParams: import("@algolia/client-search/model/searchUserIdsParams").SearchUserIdsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchUserIdsResponse").SearchUserIdsResponse>;
|
|
75
84
|
setDictionarySettings(dictionarySettingsParams: import("@algolia/client-search/model/dictionarySettingsParams").DictionarySettingsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../../../../packages/algoliasearch/builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,MAAM,IAAI,eAAe,EACzB,eAAe,EAChB,MAAM,+CAA+C,CAAC;AAKvD,OAAO,KAAK,EACV,MAAM,IAAI,eAAe,EACzB,eAAe,EAChB,MAAM,+CAA+C,CAAC;
|
|
1
|
+
{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../../../../packages/algoliasearch/builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,MAAM,IAAI,eAAe,EACzB,eAAe,EAChB,MAAM,+CAA+C,CAAC;AAKvD,OAAO,KAAK,EACV,MAAM,IAAI,eAAe,EACzB,eAAe,EAChB,MAAM,+CAA+C,CAAC;AAavD,OAAO,KAAK,EAEV,aAAa,EACd,MAAM,wBAAwB,CAAC;AAKhC,OAAO,KAAK,EACV,MAAM,IAAI,qBAAqB,EAC/B,qBAAqB,EACtB,MAAM,2DAA2D,CAAC;AAOnE,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAEpE,cAAc,UAAU,CAAC;AAEzB,eAAO,MAAM,gBAAgB,kBAAsB,CAAC;AAEpD;;GAEG;AACH,oBAAY,aAAa,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC;AAG7D,wBAAgB,aAAa,CAC3B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;;kCAiCR,iBAAiB,GAAG,iBAAiB,eAAe,CAAC,KACjE,eAAe;uCA2CH,iBAAiB,GAC5B,SAAS,iBAAiB,qBAAqB,CAAC,CAAC,KAClD,qBAAqB;kCAxBT,iBAAiB,GAAG,iBAAiB,eAAe,CAAC,KACjE,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA2DnB"}
|