algoliasearch 5.0.0-alpha.98 → 5.0.0-beta.1
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 +10 -17
- package/builds/node.ts +58 -15
- package/dist/algoliasearch/builds/browser.d.ts +10 -5
- package/dist/algoliasearch/builds/browser.d.ts.map +1 -1
- package/dist/algoliasearch/builds/node.d.ts +28 -6
- package/dist/algoliasearch/builds/node.d.ts.map +1 -1
- package/dist/algoliasearch.cjs +752 -387
- package/dist/algoliasearch.esm.browser.js +724 -393
- package/dist/algoliasearch.esm.node.js +753 -388
- package/dist/algoliasearch.umd.js +2 -2
- package/dist/client-abtesting/model/aBTest.d.ts +14 -29
- package/dist/client-abtesting/model/aBTest.d.ts.map +1 -1
- package/dist/client-abtesting/model/aBTestConfiguration.d.ts +12 -0
- package/dist/client-abtesting/model/aBTestConfiguration.d.ts.map +1 -0
- package/dist/client-abtesting/model/aBTestResponse.d.ts +3 -3
- package/dist/client-abtesting/model/abTestsVariant.d.ts +3 -3
- package/dist/client-abtesting/model/addABTestsRequest.d.ts +1 -1
- package/dist/client-abtesting/model/clientMethodProps.d.ts +7 -7
- package/dist/client-abtesting/model/{currenciesValue.d.ts → currency.d.ts} +2 -2
- package/dist/client-abtesting/model/currency.d.ts.map +1 -0
- package/dist/client-abtesting/model/customSearchParams.d.ts +1 -1
- package/dist/client-abtesting/model/effect.d.ts +5 -0
- package/dist/client-abtesting/model/effect.d.ts.map +1 -0
- package/dist/client-abtesting/model/emptySearch.d.ts +10 -0
- package/dist/client-abtesting/model/emptySearch.d.ts.map +1 -0
- package/dist/client-abtesting/model/index.d.ts +7 -1
- package/dist/client-abtesting/model/index.d.ts.map +1 -1
- package/dist/client-abtesting/model/listABTestsResponse.d.ts +2 -2
- package/dist/client-abtesting/model/listABTestsResponse.d.ts.map +1 -1
- package/dist/client-abtesting/model/minimumDetectableEffect.d.ts +12 -0
- package/dist/client-abtesting/model/minimumDetectableEffect.d.ts.map +1 -0
- package/dist/client-abtesting/model/outliers.d.ts +10 -0
- package/dist/client-abtesting/model/outliers.d.ts.map +1 -0
- package/dist/client-abtesting/model/status.d.ts +5 -0
- package/dist/client-abtesting/model/status.d.ts.map +1 -0
- package/dist/client-abtesting/model/variant.d.ts +29 -25
- package/dist/client-abtesting/model/variant.d.ts.map +1 -1
- package/dist/client-abtesting/src/abtestingClient.d.ts +28 -26
- package/dist/client-abtesting/src/abtestingClient.d.ts.map +1 -1
- package/dist/client-analytics/model/clickPositionsInner.d.ts +14 -0
- package/dist/client-analytics/model/clickPositionsInner.d.ts.map +1 -0
- package/dist/client-analytics/model/clientMethodProps.d.ts +161 -90
- package/dist/client-analytics/model/clientMethodProps.d.ts.map +1 -1
- package/dist/client-analytics/model/currenciesValue.d.ts +14 -0
- package/dist/client-analytics/model/currenciesValue.d.ts.map +1 -0
- package/dist/client-analytics/model/dailyAddToCartRates.d.ts +19 -0
- package/dist/client-analytics/model/dailyAddToCartRates.d.ts.map +1 -0
- package/dist/client-analytics/model/dailyAverageClicks.d.ts +15 -0
- package/dist/client-analytics/model/dailyAverageClicks.d.ts.map +1 -0
- package/dist/client-analytics/model/dailyClickThroughRates.d.ts +19 -0
- package/dist/client-analytics/model/dailyClickThroughRates.d.ts.map +1 -0
- package/dist/client-analytics/model/dailyConversionRates.d.ts +19 -0
- package/dist/client-analytics/model/dailyConversionRates.d.ts.map +1 -0
- package/dist/client-analytics/model/dailyNoClickRates.d.ts +19 -0
- package/dist/client-analytics/model/dailyNoClickRates.d.ts.map +1 -0
- package/dist/client-analytics/model/dailyNoResultsRates.d.ts +19 -0
- package/dist/client-analytics/model/dailyNoResultsRates.d.ts.map +1 -0
- package/dist/client-analytics/model/dailyPurchaseRates.d.ts +19 -0
- package/dist/client-analytics/model/dailyPurchaseRates.d.ts.map +1 -0
- package/dist/client-analytics/model/dailyRevenue.d.ts +12 -0
- package/dist/client-analytics/model/dailyRevenue.d.ts.map +1 -0
- package/dist/client-analytics/model/dailySearches.d.ts +11 -0
- package/dist/client-analytics/model/dailySearches.d.ts.map +1 -0
- package/dist/client-analytics/model/dailySearchesNoClicks.d.ts +15 -0
- package/dist/client-analytics/model/dailySearchesNoClicks.d.ts.map +1 -0
- package/dist/client-analytics/model/dailySearchesNoResults.d.ts +15 -0
- package/dist/client-analytics/model/dailySearchesNoResults.d.ts.map +1 -0
- package/dist/client-analytics/model/dailyUsers.d.ts +11 -0
- package/dist/client-analytics/model/dailyUsers.d.ts.map +1 -0
- package/dist/client-analytics/model/getAddToCartRateResponse.d.ts +20 -0
- package/dist/client-analytics/model/getAddToCartRateResponse.d.ts.map +1 -0
- package/dist/client-analytics/model/getAverageClickPositionResponse.d.ts +6 -6
- package/dist/client-analytics/model/getAverageClickPositionResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getClickPositionsResponse.d.ts +3 -3
- package/dist/client-analytics/model/getClickPositionsResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getClickThroughRateResponse.d.ts +7 -7
- package/dist/client-analytics/model/getClickThroughRateResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getConversionRateResponse.d.ts +20 -0
- package/dist/client-analytics/model/getConversionRateResponse.d.ts.map +1 -0
- package/dist/client-analytics/model/getNoClickRateResponse.d.ts +6 -6
- package/dist/client-analytics/model/getNoClickRateResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getNoResultsRateResponse.d.ts +6 -6
- package/dist/client-analytics/model/getNoResultsRateResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getPurchaseRateResponse.d.ts +20 -0
- package/dist/client-analytics/model/getPurchaseRateResponse.d.ts.map +1 -0
- package/dist/client-analytics/model/getRevenue.d.ts +13 -0
- package/dist/client-analytics/model/getRevenue.d.ts.map +1 -0
- package/dist/client-analytics/model/getSearchesCountResponse.d.ts +3 -3
- package/dist/client-analytics/model/getSearchesCountResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getSearchesNoClicksResponse.d.ts +3 -3
- package/dist/client-analytics/model/getSearchesNoClicksResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getSearchesNoResultsResponse.d.ts +3 -3
- package/dist/client-analytics/model/getSearchesNoResultsResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getStatusResponse.d.ts +2 -2
- package/dist/client-analytics/model/getStatusResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getTopCountriesResponse.d.ts +1 -1
- package/dist/client-analytics/model/getTopFilterAttributesResponse.d.ts +1 -1
- package/dist/client-analytics/model/getTopFilterForAttribute.d.ts +2 -4
- package/dist/client-analytics/model/getTopFilterForAttribute.d.ts.map +1 -1
- package/dist/client-analytics/model/getTopFiltersNoResultsResponse.d.ts +2 -2
- package/dist/client-analytics/model/getTopFiltersNoResultsResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getTopFiltersNoResultsValue.d.ts +2 -4
- package/dist/client-analytics/model/getTopFiltersNoResultsValue.d.ts.map +1 -1
- package/dist/client-analytics/model/getTopHitsResponse.d.ts +2 -1
- package/dist/client-analytics/model/getTopHitsResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getTopSearchesResponse.d.ts +2 -1
- package/dist/client-analytics/model/getTopSearchesResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getUsersCountResponse.d.ts +4 -4
- package/dist/client-analytics/model/getUsersCountResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/index.d.ts +23 -11
- package/dist/client-analytics/model/index.d.ts.map +1 -1
- package/dist/client-analytics/model/operator.d.ts +5 -0
- package/dist/client-analytics/model/operator.d.ts.map +1 -0
- package/dist/client-analytics/model/orderBy.d.ts +1 -1
- package/dist/client-analytics/model/topCountry.d.ts +1 -1
- package/dist/client-analytics/model/topHit.d.ts +1 -1
- package/dist/client-analytics/model/topHitWithAnalytics.d.ts +9 -9
- package/dist/client-analytics/model/topHitWithAnalytics.d.ts.map +1 -1
- package/dist/client-analytics/model/topHitWithRevenueAnalytics.d.ts +52 -0
- package/dist/client-analytics/model/topHitWithRevenueAnalytics.d.ts.map +1 -0
- package/dist/client-analytics/model/topHitsResponse.d.ts +1 -1
- package/dist/client-analytics/model/topHitsResponseWithAnalytics.d.ts +1 -1
- package/dist/client-analytics/model/topHitsResponseWithRevenueAnalytics.d.ts +8 -0
- package/dist/client-analytics/model/topHitsResponseWithRevenueAnalytics.d.ts.map +1 -0
- package/dist/client-analytics/model/topSearch.d.ts +3 -3
- package/dist/client-analytics/model/topSearchWithAnalytics.d.ts +17 -12
- package/dist/client-analytics/model/topSearchWithAnalytics.d.ts.map +1 -1
- package/dist/client-analytics/model/topSearchWithRevenueAnalytics.d.ts +65 -0
- package/dist/client-analytics/model/topSearchWithRevenueAnalytics.d.ts.map +1 -0
- package/dist/client-analytics/model/topSearchesResponse.d.ts +1 -1
- package/dist/client-analytics/model/topSearchesResponseWithAnalytics.d.ts +1 -1
- package/dist/client-analytics/model/topSearchesResponseWithRevenueAnalytics.d.ts +8 -0
- package/dist/client-analytics/model/topSearchesResponseWithRevenueAnalytics.d.ts.map +1 -0
- package/dist/client-analytics/src/analyticsClient.d.ts +211 -138
- package/dist/client-analytics/src/analyticsClient.d.ts.map +1 -1
- package/dist/client-personalization/model/clientMethodProps.d.ts +2 -2
- package/dist/client-personalization/model/deleteUserProfileResponse.d.ts +2 -2
- package/dist/client-personalization/model/eventScoring.d.ts +4 -6
- package/dist/client-personalization/model/eventScoring.d.ts.map +1 -1
- package/dist/client-personalization/model/eventType.d.ts +5 -0
- package/dist/client-personalization/model/eventType.d.ts.map +1 -0
- package/dist/client-personalization/model/facetScoring.d.ts +2 -2
- package/dist/client-personalization/model/getUserTokenResponse.d.ts +3 -3
- package/dist/client-personalization/model/index.d.ts +1 -0
- package/dist/client-personalization/model/index.d.ts.map +1 -1
- package/dist/client-personalization/model/personalizationStrategyParams.d.ts +3 -3
- package/dist/client-personalization/src/personalizationClient.d.ts +19 -19
- package/dist/client-personalization/src/personalizationClient.d.ts.map +1 -1
- package/dist/client-search/model/acl.d.ts +1 -1
- package/dist/client-search/model/action.d.ts +1 -1
- package/dist/client-search/model/addApiKeyResponse.d.ts +1 -1
- package/dist/client-search/model/anchoring.d.ts +1 -1
- package/dist/client-search/model/apiKey.d.ts +8 -8
- package/dist/client-search/model/apiKeyOperation.d.ts +2 -0
- package/dist/client-search/model/apiKeyOperation.d.ts.map +1 -0
- package/dist/client-search/model/aroundPrecision.d.ts +1 -1
- package/dist/client-search/model/aroundPrecisionFromValueInner.d.ts +9 -0
- package/dist/client-search/model/aroundPrecisionFromValueInner.d.ts.map +1 -1
- package/dist/client-search/model/aroundRadius.d.ts +1 -1
- package/dist/client-search/model/aroundRadiusAll.d.ts +3 -0
- package/dist/client-search/model/aroundRadiusAll.d.ts.map +1 -1
- package/dist/client-search/model/automaticFacetFilter.d.ts +4 -4
- package/dist/client-search/model/automaticFacetFilters.d.ts +1 -1
- package/dist/client-search/model/baseGetApiKeyResponse.d.ts +1 -1
- package/dist/client-search/model/baseIndexSettings.d.ts +22 -17
- package/dist/client-search/model/baseIndexSettings.d.ts.map +1 -1
- package/dist/client-search/model/baseSearchParamsWithoutQuery.d.ts +26 -29
- package/dist/client-search/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
- package/dist/client-search/model/baseSearchResponse.d.ts +10 -6
- package/dist/client-search/model/baseSearchResponse.d.ts.map +1 -1
- package/dist/client-search/model/batchDictionaryEntriesParams.d.ts +3 -3
- package/dist/client-search/model/batchResponse.d.ts +2 -2
- package/dist/client-search/model/builtInOperation.d.ts +2 -2
- package/dist/client-search/model/builtInOperationType.d.ts +1 -1
- package/dist/client-search/model/clientMethodProps.d.ts +124 -65
- package/dist/client-search/model/clientMethodProps.d.ts.map +1 -1
- package/dist/client-search/model/condition.d.ts +7 -3
- package/dist/client-search/model/condition.d.ts.map +1 -1
- package/dist/client-search/model/consequence.d.ts +5 -5
- package/dist/client-search/model/consequenceHide.d.ts +2 -2
- package/dist/client-search/model/consequenceQuery.d.ts +1 -1
- package/dist/client-search/model/consequenceQueryObject.d.ts +2 -2
- package/dist/client-search/model/createdAtResponse.d.ts +1 -1
- package/dist/client-search/model/cursor.d.ts +1 -1
- package/dist/client-search/model/deleteApiKeyResponse.d.ts +1 -1
- package/dist/client-search/model/deleteByParams.d.ts +4 -4
- package/dist/client-search/model/deleteSourceResponse.d.ts +1 -1
- package/dist/client-search/model/deletedAtResponse.d.ts +2 -2
- package/dist/client-search/model/dictionaryEntry.d.ts +6 -8
- package/dist/client-search/model/dictionaryEntry.d.ts.map +1 -1
- package/dist/client-search/model/dictionaryEntryState.d.ts +1 -1
- package/dist/client-search/model/dictionaryLanguage.d.ts +2 -2
- package/dist/client-search/model/dictionarySettingsParams.d.ts +1 -1
- package/dist/client-search/model/distinct.d.ts +1 -1
- package/dist/client-search/model/edit.d.ts +1 -1
- package/dist/client-search/model/exactOnSingleWordQuery.d.ts +1 -1
- package/dist/client-search/model/facetFilters.d.ts +1 -1
- package/dist/client-search/model/facetHits.d.ts +2 -2
- package/dist/client-search/model/facetOrdering.d.ts +2 -2
- package/dist/client-search/model/facets.d.ts +2 -2
- package/dist/client-search/model/fetchedIndex.d.ts +1 -1
- package/dist/client-search/model/getObjectsRequest.d.ts +3 -3
- package/dist/client-search/model/getObjectsResponse.d.ts +1 -1
- package/dist/client-search/model/hasPendingMappingsResponse.d.ts +1 -1
- package/dist/client-search/model/highlightResult.d.ts +1 -1
- package/dist/client-search/model/highlightResult.d.ts.map +1 -1
- package/dist/client-search/model/highlightResultOption.d.ts +3 -3
- package/dist/client-search/model/hit.d.ts +4 -4
- package/dist/client-search/model/ignorePlurals.d.ts +3 -2
- package/dist/client-search/model/ignorePlurals.d.ts.map +1 -1
- package/dist/client-search/model/index.d.ts +4 -0
- package/dist/client-search/model/index.d.ts.map +1 -1
- package/dist/client-search/model/indexSettings.d.ts +1 -1
- package/dist/client-search/model/indexSettingsAsSearchParams.d.ts +32 -35
- package/dist/client-search/model/indexSettingsAsSearchParams.d.ts.map +1 -1
- package/dist/client-search/model/log.d.ts +11 -11
- package/dist/client-search/model/logQuery.d.ts +1 -1
- package/dist/client-search/model/matchLevel.d.ts +1 -1
- package/dist/client-search/model/mode.d.ts +1 -1
- package/dist/client-search/model/multipleBatchRequest.d.ts +1 -1
- package/dist/client-search/model/multipleBatchResponse.d.ts +2 -2
- package/dist/client-search/model/numericFilters.d.ts +1 -1
- package/dist/client-search/model/operationIndexParams.d.ts +2 -2
- package/dist/client-search/model/operationType.d.ts +1 -1
- package/dist/client-search/model/optionalFilters.d.ts +1 -1
- package/dist/client-search/model/params.d.ts +1 -1
- package/dist/client-search/model/promoteObjectID.d.ts +2 -2
- package/dist/client-search/model/promoteObjectIDs.d.ts +2 -2
- package/dist/client-search/model/queryType.d.ts +1 -1
- package/dist/client-search/model/rankingInfo.d.ts +10 -7
- package/dist/client-search/model/rankingInfo.d.ts.map +1 -1
- package/dist/client-search/model/reRankingApplyFilter.d.ts +1 -1
- package/dist/client-search/model/removeStopWords.d.ts +3 -2
- package/dist/client-search/model/removeStopWords.d.ts.map +1 -1
- package/dist/client-search/model/removeUserIdResponse.d.ts +1 -1
- package/dist/client-search/model/removeWordsIfNoResults.d.ts +1 -1
- package/dist/client-search/model/renderingContent.d.ts +1 -1
- package/dist/client-search/model/replaceSourceResponse.d.ts +1 -1
- package/dist/client-search/model/rule.d.ts +5 -5
- package/dist/client-search/model/saveObjectResponse.d.ts +3 -3
- package/dist/client-search/model/saveSynonymResponse.d.ts +2 -2
- package/dist/client-search/model/searchDictionaryEntriesParams.d.ts +5 -7
- package/dist/client-search/model/searchDictionaryEntriesParams.d.ts.map +1 -1
- package/dist/client-search/model/searchDictionaryEntriesResponse.d.ts +20 -0
- package/dist/client-search/model/searchDictionaryEntriesResponse.d.ts.map +1 -0
- package/dist/client-search/model/searchForFacetValuesRequest.d.ts +1 -1
- package/dist/client-search/model/searchForFacetValuesResponse.d.ts +3 -0
- package/dist/client-search/model/searchForFacetValuesResponse.d.ts.map +1 -1
- package/dist/client-search/model/searchForFacetsOptions.d.ts +2 -2
- package/dist/client-search/model/searchForHitsOptions.d.ts +1 -1
- package/dist/client-search/model/searchHits.d.ts +6 -3
- package/dist/client-search/model/searchHits.d.ts.map +1 -1
- package/dist/client-search/model/searchParamsObject.d.ts +3 -0
- package/dist/client-search/model/searchParamsObject.d.ts.map +1 -1
- package/dist/client-search/model/searchParamsQuery.d.ts +1 -1
- package/dist/client-search/model/searchRulesParams.d.ts +4 -8
- package/dist/client-search/model/searchRulesParams.d.ts.map +1 -1
- package/dist/client-search/model/searchRulesResponse.d.ts +2 -2
- package/dist/client-search/model/searchStrategy.d.ts +1 -1
- package/dist/client-search/model/searchSynonymsParams.d.ts +2 -2
- package/dist/client-search/model/searchSynonymsResponse.d.ts +2 -2
- package/dist/client-search/model/searchUserIdsParams.d.ts +1 -1
- package/dist/client-search/model/searchUserIdsResponse.d.ts +3 -3
- package/dist/client-search/model/securedAPIKeyRestrictions.d.ts +25 -0
- package/dist/client-search/model/securedAPIKeyRestrictions.d.ts.map +1 -0
- package/dist/client-search/model/semanticSearch.d.ts +2 -2
- package/dist/client-search/model/snippetResult.d.ts +1 -1
- package/dist/client-search/model/snippetResult.d.ts.map +1 -1
- package/dist/client-search/model/snippetResultOption.d.ts +2 -2
- package/dist/client-search/model/sortRemainingBy.d.ts +1 -1
- package/dist/client-search/model/supportedLanguage.d.ts +5 -0
- package/dist/client-search/model/supportedLanguage.d.ts.map +1 -0
- package/dist/client-search/model/tagFilters.d.ts +1 -1
- package/dist/client-search/model/taskStatus.d.ts +1 -1
- package/dist/client-search/model/timeRange.d.ts +2 -2
- package/dist/client-search/model/typoTolerance.d.ts +1 -1
- package/dist/client-search/model/typoToleranceEnum.d.ts +3 -0
- package/dist/client-search/model/typoToleranceEnum.d.ts.map +1 -1
- package/dist/client-search/model/updateApiKeyResponse.d.ts +1 -1
- package/dist/client-search/model/updatedAtResponse.d.ts +2 -2
- package/dist/client-search/model/updatedAtWithObjectIdResponse.d.ts +3 -3
- package/dist/client-search/model/updatedRuleResponse.d.ts +3 -3
- package/dist/client-search/model/userHit.d.ts +1 -1
- package/dist/client-search/model/userId.d.ts +1 -1
- package/dist/client-search/model/value.d.ts +1 -1
- package/dist/client-search/src/searchClient.d.ts +324 -202
- package/dist/client-search/src/searchClient.d.ts.map +1 -1
- package/dist/lite/builds/browser.d.ts +14 -3
- package/dist/lite/builds/browser.d.ts.map +1 -1
- package/dist/lite/builds/node.d.ts +14 -3
- package/dist/lite/builds/node.d.ts.map +1 -1
- package/dist/lite/lite.cjs +8 -6
- package/dist/lite/lite.esm.browser.js +13 -14
- package/dist/lite/lite.esm.node.js +8 -6
- package/dist/lite/lite.umd.js +2 -2
- package/dist/lite/model/acl.d.ts +1 -1
- package/dist/lite/model/action.d.ts +1 -1
- package/dist/lite/model/addApiKeyResponse.d.ts +1 -1
- package/dist/lite/model/anchoring.d.ts +1 -1
- package/dist/lite/model/apiKey.d.ts +8 -8
- package/dist/lite/model/apiKeyOperation.d.ts +2 -0
- package/dist/lite/model/apiKeyOperation.d.ts.map +1 -0
- package/dist/lite/model/aroundPrecision.d.ts +1 -1
- package/dist/lite/model/aroundPrecisionFromValueInner.d.ts +9 -0
- package/dist/lite/model/aroundPrecisionFromValueInner.d.ts.map +1 -1
- package/dist/lite/model/aroundRadius.d.ts +1 -1
- package/dist/lite/model/aroundRadiusAll.d.ts +3 -0
- package/dist/lite/model/aroundRadiusAll.d.ts.map +1 -1
- package/dist/lite/model/automaticFacetFilter.d.ts +4 -4
- package/dist/lite/model/automaticFacetFilters.d.ts +1 -1
- package/dist/lite/model/baseGetApiKeyResponse.d.ts +1 -1
- package/dist/lite/model/baseIndexSettings.d.ts +22 -17
- package/dist/lite/model/baseIndexSettings.d.ts.map +1 -1
- package/dist/lite/model/baseSearchParamsWithoutQuery.d.ts +26 -29
- package/dist/lite/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
- package/dist/lite/model/baseSearchResponse.d.ts +10 -6
- package/dist/lite/model/baseSearchResponse.d.ts.map +1 -1
- package/dist/lite/model/builtInOperation.d.ts +2 -2
- package/dist/lite/model/builtInOperationType.d.ts +1 -1
- package/dist/lite/model/condition.d.ts +7 -3
- package/dist/lite/model/condition.d.ts.map +1 -1
- package/dist/lite/model/consequence.d.ts +5 -5
- package/dist/lite/model/consequenceHide.d.ts +2 -2
- package/dist/lite/model/consequenceQuery.d.ts +1 -1
- package/dist/lite/model/consequenceQueryObject.d.ts +2 -2
- package/dist/lite/model/cursor.d.ts +1 -1
- package/dist/lite/model/deleteByParams.d.ts +4 -4
- package/dist/lite/model/dictionaryEntry.d.ts +6 -8
- package/dist/lite/model/dictionaryEntry.d.ts.map +1 -1
- package/dist/lite/model/dictionaryEntryState.d.ts +1 -1
- package/dist/lite/model/dictionaryLanguage.d.ts +2 -2
- package/dist/lite/model/distinct.d.ts +1 -1
- package/dist/lite/model/edit.d.ts +1 -1
- package/dist/lite/model/exactOnSingleWordQuery.d.ts +1 -1
- package/dist/lite/model/facetFilters.d.ts +1 -1
- package/dist/lite/model/facetHits.d.ts +2 -2
- package/dist/lite/model/facetOrdering.d.ts +2 -2
- package/dist/lite/model/facets.d.ts +2 -2
- package/dist/lite/model/fetchedIndex.d.ts +1 -1
- package/dist/lite/model/highlightResult.d.ts +1 -1
- package/dist/lite/model/highlightResult.d.ts.map +1 -1
- package/dist/lite/model/highlightResultOption.d.ts +3 -3
- package/dist/lite/model/hit.d.ts +4 -4
- package/dist/lite/model/ignorePlurals.d.ts +3 -2
- package/dist/lite/model/ignorePlurals.d.ts.map +1 -1
- package/dist/lite/model/index.d.ts +4 -0
- package/dist/lite/model/index.d.ts.map +1 -1
- package/dist/lite/model/indexSettings.d.ts +1 -1
- package/dist/lite/model/indexSettingsAsSearchParams.d.ts +32 -35
- package/dist/lite/model/indexSettingsAsSearchParams.d.ts.map +1 -1
- package/dist/lite/model/matchLevel.d.ts +1 -1
- package/dist/lite/model/mode.d.ts +1 -1
- package/dist/lite/model/numericFilters.d.ts +1 -1
- package/dist/lite/model/operationType.d.ts +1 -1
- package/dist/lite/model/optionalFilters.d.ts +1 -1
- package/dist/lite/model/params.d.ts +1 -1
- package/dist/lite/model/promoteObjectID.d.ts +2 -2
- package/dist/lite/model/promoteObjectIDs.d.ts +2 -2
- package/dist/lite/model/queryType.d.ts +1 -1
- package/dist/lite/model/rankingInfo.d.ts +10 -7
- package/dist/lite/model/rankingInfo.d.ts.map +1 -1
- package/dist/lite/model/reRankingApplyFilter.d.ts +1 -1
- package/dist/lite/model/removeStopWords.d.ts +3 -2
- package/dist/lite/model/removeStopWords.d.ts.map +1 -1
- package/dist/lite/model/removeWordsIfNoResults.d.ts +1 -1
- package/dist/lite/model/renderingContent.d.ts +1 -1
- package/dist/lite/model/rule.d.ts +5 -5
- package/dist/lite/model/searchDictionaryEntriesResponse.d.ts +20 -0
- package/dist/lite/model/searchDictionaryEntriesResponse.d.ts.map +1 -0
- package/dist/lite/model/searchForFacetValuesResponse.d.ts +3 -0
- package/dist/lite/model/searchForFacetValuesResponse.d.ts.map +1 -1
- package/dist/lite/model/searchForFacetsOptions.d.ts +2 -2
- package/dist/lite/model/searchForHitsOptions.d.ts +1 -1
- package/dist/lite/model/searchHits.d.ts +6 -3
- package/dist/lite/model/searchHits.d.ts.map +1 -1
- package/dist/lite/model/searchParamsObject.d.ts +3 -0
- package/dist/lite/model/searchParamsObject.d.ts.map +1 -1
- package/dist/lite/model/searchParamsQuery.d.ts +1 -1
- package/dist/lite/model/searchStrategy.d.ts +1 -1
- package/dist/lite/model/searchSynonymsResponse.d.ts +2 -2
- package/dist/lite/model/securedAPIKeyRestrictions.d.ts +25 -0
- package/dist/lite/model/securedAPIKeyRestrictions.d.ts.map +1 -0
- package/dist/lite/model/semanticSearch.d.ts +2 -2
- package/dist/lite/model/snippetResult.d.ts +1 -1
- package/dist/lite/model/snippetResult.d.ts.map +1 -1
- package/dist/lite/model/snippetResultOption.d.ts +2 -2
- package/dist/lite/model/sortRemainingBy.d.ts +1 -1
- package/dist/lite/model/supportedLanguage.d.ts +5 -0
- package/dist/lite/model/supportedLanguage.d.ts.map +1 -0
- package/dist/lite/model/tagFilters.d.ts +1 -1
- package/dist/lite/model/taskStatus.d.ts +1 -1
- package/dist/lite/model/timeRange.d.ts +2 -2
- package/dist/lite/model/typoTolerance.d.ts +1 -1
- package/dist/lite/model/typoToleranceEnum.d.ts +3 -0
- package/dist/lite/model/typoToleranceEnum.d.ts.map +1 -1
- package/dist/lite/model/updatedRuleResponse.d.ts +3 -3
- package/dist/lite/model/userId.d.ts +1 -1
- package/dist/lite/model/value.d.ts +1 -1
- package/dist/lite/src/liteClient.d.ts +6 -9
- package/dist/lite/src/liteClient.d.ts.map +1 -1
- package/lite/builds/browser.ts +11 -6
- package/lite/builds/node.ts +10 -5
- package/lite/model/acl.ts +1 -1
- package/lite/model/action.ts +1 -1
- package/lite/model/addApiKeyResponse.ts +1 -1
- package/lite/model/anchoring.ts +1 -1
- package/lite/model/apiKey.ts +8 -8
- package/lite/model/apiKeyOperation.ts +3 -0
- package/lite/model/aroundPrecision.ts +1 -1
- package/lite/model/aroundPrecisionFromValueInner.ts +9 -0
- package/lite/model/aroundRadius.ts +1 -1
- package/lite/model/aroundRadiusAll.ts +3 -0
- package/lite/model/automaticFacetFilter.ts +4 -4
- package/lite/model/automaticFacetFilters.ts +1 -1
- package/lite/model/baseGetApiKeyResponse.ts +1 -1
- package/lite/model/baseIndexSettings.ts +24 -17
- package/lite/model/baseSearchParamsWithoutQuery.ts +26 -30
- package/lite/model/baseSearchResponse.ts +11 -6
- package/lite/model/builtInOperation.ts +2 -2
- package/lite/model/builtInOperationType.ts +1 -1
- package/lite/model/condition.ts +8 -3
- package/lite/model/consequence.ts +5 -5
- package/lite/model/consequenceHide.ts +2 -2
- package/lite/model/consequenceQuery.ts +1 -1
- package/lite/model/consequenceQueryObject.ts +2 -2
- package/lite/model/cursor.ts +1 -1
- package/lite/model/deleteByParams.ts +4 -4
- package/lite/model/dictionaryEntry.ts +6 -8
- package/lite/model/dictionaryEntryState.ts +1 -1
- package/lite/model/dictionaryLanguage.ts +2 -2
- package/lite/model/distinct.ts +1 -1
- package/lite/model/edit.ts +1 -1
- package/lite/model/exactOnSingleWordQuery.ts +1 -1
- package/lite/model/facetFilters.ts +1 -1
- package/lite/model/facetHits.ts +2 -2
- package/lite/model/facetOrdering.ts +2 -2
- package/lite/model/facets.ts +2 -2
- package/lite/model/fetchedIndex.ts +1 -1
- package/lite/model/highlightResult.ts +1 -0
- package/lite/model/highlightResultOption.ts +3 -3
- package/lite/model/hit.ts +4 -4
- package/lite/model/ignorePlurals.ts +4 -2
- package/lite/model/index.ts +4 -0
- package/lite/model/indexSettings.ts +1 -1
- package/lite/model/indexSettingsAsSearchParams.ts +32 -36
- package/lite/model/matchLevel.ts +1 -1
- package/lite/model/mode.ts +1 -1
- package/lite/model/numericFilters.ts +1 -1
- package/lite/model/operationType.ts +1 -1
- package/lite/model/optionalFilters.ts +1 -1
- package/lite/model/params.ts +1 -1
- package/lite/model/promoteObjectID.ts +2 -2
- package/lite/model/promoteObjectIDs.ts +2 -2
- package/lite/model/queryType.ts +1 -1
- package/lite/model/rankingInfo.ts +10 -7
- package/lite/model/reRankingApplyFilter.ts +1 -1
- package/lite/model/removeStopWords.ts +4 -2
- package/lite/model/removeWordsIfNoResults.ts +1 -1
- package/lite/model/renderingContent.ts +1 -1
- package/lite/model/rule.ts +5 -5
- package/lite/model/searchDictionaryEntriesResponse.ts +25 -0
- package/lite/model/searchForFacetValuesResponse.ts +3 -0
- package/lite/model/searchForFacetsOptions.ts +2 -2
- package/lite/model/searchForHitsOptions.ts +1 -1
- package/lite/model/searchHits.ts +6 -3
- package/lite/model/searchParamsObject.ts +3 -0
- package/lite/model/searchParamsQuery.ts +1 -1
- package/lite/model/searchStrategy.ts +1 -1
- package/lite/model/searchSynonymsResponse.ts +2 -2
- package/lite/model/securedAPIKeyRestrictions.ts +32 -0
- package/lite/model/semanticSearch.ts +2 -2
- package/lite/model/snippetResult.ts +2 -1
- package/lite/model/snippetResultOption.ts +2 -2
- package/lite/model/sortRemainingBy.ts +1 -1
- package/lite/model/supportedLanguage.ts +74 -0
- package/lite/model/tagFilters.ts +1 -1
- package/lite/model/taskStatus.ts +1 -1
- package/lite/model/timeRange.ts +2 -2
- package/lite/model/typoTolerance.ts +1 -1
- package/lite/model/typoToleranceEnum.ts +3 -0
- package/lite/model/updatedRuleResponse.ts +3 -3
- package/lite/model/userId.ts +1 -1
- package/lite/model/value.ts +1 -1
- package/lite/src/liteClient.ts +8 -12
- package/package.json +14 -14
- package/dist/client-abtesting/model/currenciesValue.d.ts.map +0 -1
- package/dist/client-analytics/model/averageClickEvent.d.ts +0 -15
- package/dist/client-analytics/model/averageClickEvent.d.ts.map +0 -1
- package/dist/client-analytics/model/clickPosition.d.ts +0 -11
- package/dist/client-analytics/model/clickPosition.d.ts.map +0 -1
- package/dist/client-analytics/model/clickThroughRateEvent.d.ts +0 -19
- package/dist/client-analytics/model/clickThroughRateEvent.d.ts.map +0 -1
- package/dist/client-analytics/model/conversionRateEvent.d.ts +0 -19
- package/dist/client-analytics/model/conversionRateEvent.d.ts.map +0 -1
- package/dist/client-analytics/model/getConversationRateResponse.d.ts +0 -20
- package/dist/client-analytics/model/getConversationRateResponse.d.ts.map +0 -1
- package/dist/client-analytics/model/noClickRateEvent.d.ts +0 -19
- package/dist/client-analytics/model/noClickRateEvent.d.ts.map +0 -1
- package/dist/client-analytics/model/noResultsRateEvent.d.ts +0 -19
- package/dist/client-analytics/model/noResultsRateEvent.d.ts.map +0 -1
- package/dist/client-analytics/model/searchEvent.d.ts +0 -11
- package/dist/client-analytics/model/searchEvent.d.ts.map +0 -1
- package/dist/client-analytics/model/searchNoClickEvent.d.ts +0 -15
- package/dist/client-analytics/model/searchNoClickEvent.d.ts.map +0 -1
- package/dist/client-analytics/model/searchNoResultEvent.d.ts +0 -15
- package/dist/client-analytics/model/searchNoResultEvent.d.ts.map +0 -1
- package/dist/client-analytics/model/userWithDate.d.ts +0 -11
- package/dist/client-analytics/model/userWithDate.d.ts.map +0 -1
package/builds/browser.ts
CHANGED
|
@@ -1,41 +1,35 @@
|
|
|
1
1
|
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
|
-
import type {
|
|
4
|
-
|
|
5
|
-
AbtestingClient,
|
|
6
|
-
} from '@algolia/client-abtesting/src/abtestingClient';
|
|
3
|
+
import type { AbtestingClient } from '@algolia/client-abtesting';
|
|
4
|
+
import type { Region as AbtestingRegion } from '@algolia/client-abtesting/src/abtestingClient';
|
|
7
5
|
import {
|
|
8
6
|
createAbtestingClient,
|
|
9
7
|
REGIONS as abtestingRegions,
|
|
10
8
|
} from '@algolia/client-abtesting/src/abtestingClient';
|
|
11
|
-
import type {
|
|
12
|
-
|
|
13
|
-
AnalyticsClient,
|
|
14
|
-
} from '@algolia/client-analytics/src/analyticsClient';
|
|
9
|
+
import type { AnalyticsClient } from '@algolia/client-analytics';
|
|
10
|
+
import type { Region as AnalyticsRegion } from '@algolia/client-analytics/src/analyticsClient';
|
|
15
11
|
import {
|
|
16
12
|
createAnalyticsClient,
|
|
17
13
|
REGIONS as analyticsRegions,
|
|
18
14
|
} from '@algolia/client-analytics/src/analyticsClient';
|
|
19
15
|
import {
|
|
20
|
-
createMemoryCache,
|
|
21
|
-
createFallbackableCache,
|
|
22
|
-
createBrowserLocalStorageCache,
|
|
23
16
|
DEFAULT_CONNECT_TIMEOUT_BROWSER,
|
|
24
17
|
DEFAULT_READ_TIMEOUT_BROWSER,
|
|
25
18
|
DEFAULT_WRITE_TIMEOUT_BROWSER,
|
|
19
|
+
createBrowserLocalStorageCache,
|
|
20
|
+
createFallbackableCache,
|
|
21
|
+
createMemoryCache,
|
|
26
22
|
} from '@algolia/client-common';
|
|
27
23
|
import type {
|
|
28
|
-
CreateClientOptions,
|
|
29
24
|
ClientOptions,
|
|
25
|
+
CreateClientOptions,
|
|
30
26
|
} from '@algolia/client-common';
|
|
27
|
+
import type { PersonalizationClient } from '@algolia/client-personalization';
|
|
28
|
+
import type { Region as PersonalizationRegion } from '@algolia/client-personalization/src/personalizationClient';
|
|
31
29
|
import {
|
|
32
30
|
createPersonalizationClient,
|
|
33
31
|
REGIONS as personalizationRegions,
|
|
34
32
|
} from '@algolia/client-personalization/src/personalizationClient';
|
|
35
|
-
import type {
|
|
36
|
-
Region as PersonalizationRegion,
|
|
37
|
-
PersonalizationClient,
|
|
38
|
-
} from '@algolia/client-personalization/src/personalizationClient';
|
|
39
33
|
import {
|
|
40
34
|
createSearchClient,
|
|
41
35
|
apiClientVersion as searchClientVersion,
|
|
@@ -66,7 +60,6 @@ export function algoliasearch(
|
|
|
66
60
|
if (!apiKey || typeof apiKey !== 'string') {
|
|
67
61
|
throw new Error('`apiKey` is missing.');
|
|
68
62
|
}
|
|
69
|
-
|
|
70
63
|
const commonOptions: CreateClientOptions = {
|
|
71
64
|
apiKey,
|
|
72
65
|
appId,
|
package/builds/node.ts
CHANGED
|
@@ -1,22 +1,21 @@
|
|
|
1
1
|
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
|
-
import
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
} from '@algolia/client-abtesting/src/abtestingClient';
|
|
3
|
+
import { createHmac } from 'crypto';
|
|
4
|
+
|
|
5
|
+
import type { AbtestingClient } from '@algolia/client-abtesting';
|
|
6
|
+
import type { Region as AbtestingRegion } from '@algolia/client-abtesting/src/abtestingClient';
|
|
7
7
|
import {
|
|
8
8
|
createAbtestingClient,
|
|
9
9
|
REGIONS as abtestingRegions,
|
|
10
10
|
} from '@algolia/client-abtesting/src/abtestingClient';
|
|
11
|
-
import type {
|
|
12
|
-
|
|
13
|
-
AnalyticsClient,
|
|
14
|
-
} from '@algolia/client-analytics/src/analyticsClient';
|
|
11
|
+
import type { AnalyticsClient } from '@algolia/client-analytics';
|
|
12
|
+
import type { Region as AnalyticsRegion } from '@algolia/client-analytics/src/analyticsClient';
|
|
15
13
|
import {
|
|
16
14
|
createAnalyticsClient,
|
|
17
15
|
REGIONS as analyticsRegions,
|
|
18
16
|
} from '@algolia/client-analytics/src/analyticsClient';
|
|
19
17
|
import {
|
|
18
|
+
serializeQueryParameters,
|
|
20
19
|
DEFAULT_CONNECT_TIMEOUT_NODE,
|
|
21
20
|
DEFAULT_READ_TIMEOUT_NODE,
|
|
22
21
|
DEFAULT_WRITE_TIMEOUT_NODE,
|
|
@@ -24,24 +23,27 @@ import {
|
|
|
24
23
|
createNullCache,
|
|
25
24
|
} from '@algolia/client-common';
|
|
26
25
|
import type {
|
|
27
|
-
CreateClientOptions,
|
|
28
26
|
ClientOptions,
|
|
27
|
+
CreateClientOptions,
|
|
29
28
|
} from '@algolia/client-common';
|
|
29
|
+
import type { PersonalizationClient } from '@algolia/client-personalization';
|
|
30
|
+
import type { Region as PersonalizationRegion } from '@algolia/client-personalization/src/personalizationClient';
|
|
30
31
|
import {
|
|
31
32
|
createPersonalizationClient,
|
|
32
33
|
REGIONS as personalizationRegions,
|
|
33
34
|
} from '@algolia/client-personalization/src/personalizationClient';
|
|
34
|
-
import type {
|
|
35
|
-
Region as PersonalizationRegion,
|
|
36
|
-
PersonalizationClient,
|
|
37
|
-
} from '@algolia/client-personalization/src/personalizationClient';
|
|
38
35
|
import {
|
|
39
36
|
createSearchClient,
|
|
40
37
|
apiClientVersion as searchClientVersion,
|
|
41
38
|
} from '@algolia/client-search/src/searchClient';
|
|
42
39
|
import { createHttpRequester } from '@algolia/requester-node-http';
|
|
43
40
|
|
|
44
|
-
import type {
|
|
41
|
+
import type {
|
|
42
|
+
InitClientOptions,
|
|
43
|
+
InitClientRegion,
|
|
44
|
+
GenerateSecuredApiKeyOptions,
|
|
45
|
+
GetSecuredApiKeyRemainingValidityOptions,
|
|
46
|
+
} from './models';
|
|
45
47
|
|
|
46
48
|
export * from './models';
|
|
47
49
|
|
|
@@ -65,7 +67,6 @@ export function algoliasearch(
|
|
|
65
67
|
if (!apiKey || typeof apiKey !== 'string') {
|
|
66
68
|
throw new Error('`apiKey` is missing.');
|
|
67
69
|
}
|
|
68
|
-
|
|
69
70
|
const commonOptions: CreateClientOptions = {
|
|
70
71
|
apiKey,
|
|
71
72
|
appId,
|
|
@@ -155,5 +156,47 @@ export function algoliasearch(
|
|
|
155
156
|
initAnalytics,
|
|
156
157
|
initPersonalization,
|
|
157
158
|
initAbtesting,
|
|
159
|
+
/**
|
|
160
|
+
* Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
|
|
161
|
+
*
|
|
162
|
+
* @summary Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
|
|
163
|
+
* @param generateSecuredApiKey - The `generateSecuredApiKey` object.
|
|
164
|
+
* @param generateSecuredApiKey.parentApiKey - The base API key from which to generate the new secured one.
|
|
165
|
+
* @param generateSecuredApiKey.restrictions - A set of properties defining the restrictions of the secured API key.
|
|
166
|
+
*/
|
|
167
|
+
generateSecuredApiKey({
|
|
168
|
+
parentApiKey,
|
|
169
|
+
restrictions = {},
|
|
170
|
+
}: GenerateSecuredApiKeyOptions): string {
|
|
171
|
+
const queryParameters = serializeQueryParameters(restrictions);
|
|
172
|
+
return Buffer.from(
|
|
173
|
+
createHmac('sha256', parentApiKey)
|
|
174
|
+
.update(queryParameters)
|
|
175
|
+
.digest('hex') + queryParameters
|
|
176
|
+
).toString('base64');
|
|
177
|
+
},
|
|
178
|
+
|
|
179
|
+
/**
|
|
180
|
+
* Helper: Retrieves the remaining validity of the previous generated `securedApiKey`, the `ValidUntil` parameter must have been provided.
|
|
181
|
+
*
|
|
182
|
+
* @summary Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
|
|
183
|
+
* @param getSecuredApiKeyRemainingValidity - The `getSecuredApiKeyRemainingValidity` object.
|
|
184
|
+
* @param getSecuredApiKeyRemainingValidity.securedApiKey - The secured API key generated with the `generateSecuredApiKey` method.
|
|
185
|
+
*/
|
|
186
|
+
getSecuredApiKeyRemainingValidity({
|
|
187
|
+
securedApiKey,
|
|
188
|
+
}: GetSecuredApiKeyRemainingValidityOptions): number {
|
|
189
|
+
const decodedString = Buffer.from(securedApiKey, 'base64').toString(
|
|
190
|
+
'ascii'
|
|
191
|
+
);
|
|
192
|
+
const regex = /validUntil=(\d+)/;
|
|
193
|
+
const match = decodedString.match(regex);
|
|
194
|
+
|
|
195
|
+
if (match === null) {
|
|
196
|
+
throw new Error('validUntil not found in given secured api key.');
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
return parseInt(match[1], 10) - Math.round(new Date().getTime() / 1000);
|
|
200
|
+
},
|
|
158
201
|
};
|
|
159
202
|
}
|
|
@@ -1,10 +1,13 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
import type { Region as
|
|
1
|
+
import type { AbtestingClient } from '@algolia/client-abtesting';
|
|
2
|
+
import type { Region as AbtestingRegion } from '@algolia/client-abtesting/src/abtestingClient';
|
|
3
|
+
import type { AnalyticsClient } from '@algolia/client-analytics';
|
|
4
|
+
import type { Region as AnalyticsRegion } from '@algolia/client-analytics/src/analyticsClient';
|
|
3
5
|
import type { ClientOptions } from '@algolia/client-common';
|
|
4
|
-
import type {
|
|
6
|
+
import type { PersonalizationClient } from '@algolia/client-personalization';
|
|
7
|
+
import type { Region as PersonalizationRegion } from '@algolia/client-personalization/src/personalizationClient';
|
|
5
8
|
import type { InitClientOptions, InitClientRegion } from './models';
|
|
6
9
|
export * from './models';
|
|
7
|
-
export declare const apiClientVersion = "5.0.0-
|
|
10
|
+
export declare const apiClientVersion = "5.0.0-beta.1";
|
|
8
11
|
/**
|
|
9
12
|
* The client type.
|
|
10
13
|
*/
|
|
@@ -29,6 +32,8 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
|
|
|
29
32
|
searchForFacets(searchMethodParams: import("@algolia/client-search/model/clientMethodProps").LegacySearchMethodProps | import("@algolia/client-search/model/searchMethodParams").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<{
|
|
30
33
|
results: import("@algolia/client-search/model/searchForFacetValuesResponse").SearchForFacetValuesResponse[];
|
|
31
34
|
}>;
|
|
35
|
+
chunkedBatch({ indexName, objects, action, waitForTasks, batchSize, }: import("@algolia/client-search/model/clientMethodProps").ChunkedBatchOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
|
|
36
|
+
replaceAllObjects({ indexName, objects, batchSize }: import("@algolia/client-search/model/clientMethodProps").ReplaceAllObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/clientMethodProps").ReplaceAllObjectsResponse>;
|
|
32
37
|
addApiKey(apiKey: import("@algolia/client-search/model/apiKey").ApiKey, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/addApiKeyResponse").AddApiKeyResponse>;
|
|
33
38
|
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>;
|
|
34
39
|
appendSource(source: import("@algolia/client-search/model/source").Source, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/createdAtResponse").CreatedAtResponse>;
|
|
@@ -81,7 +86,7 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
|
|
|
81
86
|
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>;
|
|
82
87
|
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>;
|
|
83
88
|
search<T_4>(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_4>>;
|
|
84
|
-
searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams, }: import("@algolia/client-search/model/clientMethodProps").SearchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/
|
|
89
|
+
searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams, }: import("@algolia/client-search/model/clientMethodProps").SearchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchDictionaryEntriesResponse").SearchDictionaryEntriesResponse>;
|
|
85
90
|
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>;
|
|
86
91
|
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>;
|
|
87
92
|
searchSingleIndex<T_5>({ 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_5>>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,KAAK,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,+CAA+C,CAAC;AAK/F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,KAAK,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,+CAA+C,CAAC;AAa/F,OAAO,KAAK,EACV,aAAa,EAEd,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,KAAK,EAAE,MAAM,IAAI,qBAAqB,EAAE,MAAM,2DAA2D,CAAC;AAWjH,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAEpE,cAAc,UAAU,CAAC;AAEzB,eAAO,MAAM,gBAAgB,iBAAsB,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC;AAG7D,wBAAgB,aAAa,CAC3B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;;kCAgCR,iBAAiB,GAAG,iBAAiB,eAAe,CAAC,KACjE,eAAe;uCAuCH,iBAAiB,GAC5B,SAAS,iBAAiB,qBAAqB,CAAC,CAAC,KAClD,qBAAqB;kCAtBT,iBAAiB,GAAG,iBAAiB,eAAe,CAAC,KACjE,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAoDnB"}
|
|
@@ -1,10 +1,13 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
import type { Region as
|
|
1
|
+
import type { AbtestingClient } from '@algolia/client-abtesting';
|
|
2
|
+
import type { Region as AbtestingRegion } from '@algolia/client-abtesting/src/abtestingClient';
|
|
3
|
+
import type { AnalyticsClient } from '@algolia/client-analytics';
|
|
4
|
+
import type { Region as AnalyticsRegion } from '@algolia/client-analytics/src/analyticsClient';
|
|
3
5
|
import type { ClientOptions } from '@algolia/client-common';
|
|
4
|
-
import type {
|
|
5
|
-
import type {
|
|
6
|
+
import type { PersonalizationClient } from '@algolia/client-personalization';
|
|
7
|
+
import type { Region as PersonalizationRegion } from '@algolia/client-personalization/src/personalizationClient';
|
|
8
|
+
import type { InitClientOptions, InitClientRegion, GenerateSecuredApiKeyOptions, GetSecuredApiKeyRemainingValidityOptions } from './models';
|
|
6
9
|
export * from './models';
|
|
7
|
-
export declare const apiClientVersion = "5.0.0-
|
|
10
|
+
export declare const apiClientVersion = "5.0.0-beta.1";
|
|
8
11
|
/**
|
|
9
12
|
* The client type.
|
|
10
13
|
*/
|
|
@@ -14,6 +17,23 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
|
|
|
14
17
|
initAnalytics: (initOptions?: InitClientOptions & InitClientRegion<AnalyticsRegion>) => AnalyticsClient;
|
|
15
18
|
initPersonalization: (initOptions: InitClientOptions & Required<InitClientRegion<PersonalizationRegion>>) => PersonalizationClient;
|
|
16
19
|
initAbtesting: (initOptions?: InitClientOptions & InitClientRegion<AbtestingRegion>) => AbtestingClient;
|
|
20
|
+
/**
|
|
21
|
+
* Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
|
|
22
|
+
*
|
|
23
|
+
* @summary Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
|
|
24
|
+
* @param generateSecuredApiKey - The `generateSecuredApiKey` object.
|
|
25
|
+
* @param generateSecuredApiKey.parentApiKey - The base API key from which to generate the new secured one.
|
|
26
|
+
* @param generateSecuredApiKey.restrictions - A set of properties defining the restrictions of the secured API key.
|
|
27
|
+
*/
|
|
28
|
+
generateSecuredApiKey({ parentApiKey, restrictions, }: GenerateSecuredApiKeyOptions): string;
|
|
29
|
+
/**
|
|
30
|
+
* Helper: Retrieves the remaining validity of the previous generated `securedApiKey`, the `ValidUntil` parameter must have been provided.
|
|
31
|
+
*
|
|
32
|
+
* @summary Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
|
|
33
|
+
* @param getSecuredApiKeyRemainingValidity - The `getSecuredApiKeyRemainingValidity` object.
|
|
34
|
+
* @param getSecuredApiKeyRemainingValidity.securedApiKey - The secured API key generated with the `generateSecuredApiKey` method.
|
|
35
|
+
*/
|
|
36
|
+
getSecuredApiKeyRemainingValidity({ securedApiKey, }: GetSecuredApiKeyRemainingValidityOptions): number;
|
|
17
37
|
transporter: import("@algolia/client-common").Transporter;
|
|
18
38
|
appId: string;
|
|
19
39
|
clearCache(): Promise<void>;
|
|
@@ -29,6 +49,8 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
|
|
|
29
49
|
searchForFacets(searchMethodParams: import("@algolia/client-search/model/clientMethodProps").LegacySearchMethodProps | import("@algolia/client-search/model/searchMethodParams").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<{
|
|
30
50
|
results: import("@algolia/client-search/model/searchForFacetValuesResponse").SearchForFacetValuesResponse[];
|
|
31
51
|
}>;
|
|
52
|
+
chunkedBatch({ indexName, objects, action, waitForTasks, batchSize, }: import("@algolia/client-search/model/clientMethodProps").ChunkedBatchOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
|
|
53
|
+
replaceAllObjects({ indexName, objects, batchSize }: import("@algolia/client-search/model/clientMethodProps").ReplaceAllObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/clientMethodProps").ReplaceAllObjectsResponse>;
|
|
32
54
|
addApiKey(apiKey: import("@algolia/client-search/model/apiKey").ApiKey, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/addApiKeyResponse").AddApiKeyResponse>;
|
|
33
55
|
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>;
|
|
34
56
|
appendSource(source: import("@algolia/client-search/model/source").Source, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/createdAtResponse").CreatedAtResponse>;
|
|
@@ -81,7 +103,7 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
|
|
|
81
103
|
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>;
|
|
82
104
|
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>;
|
|
83
105
|
search<T_4>(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_4>>;
|
|
84
|
-
searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams, }: import("@algolia/client-search/model/clientMethodProps").SearchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/
|
|
106
|
+
searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams, }: import("@algolia/client-search/model/clientMethodProps").SearchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchDictionaryEntriesResponse").SearchDictionaryEntriesResponse>;
|
|
85
107
|
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>;
|
|
86
108
|
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>;
|
|
87
109
|
searchSingleIndex<T_5>({ 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_5>>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../../builds/node.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../../builds/node.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,KAAK,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,+CAA+C,CAAC;AAK/F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,KAAK,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,+CAA+C,CAAC;AAa/F,OAAO,KAAK,EACV,aAAa,EAEd,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,KAAK,EAAE,MAAM,IAAI,qBAAqB,EAAE,MAAM,2DAA2D,CAAC;AAWjH,OAAO,KAAK,EACV,iBAAiB,EACjB,gBAAgB,EAChB,4BAA4B,EAC5B,wCAAwC,EACzC,MAAM,UAAU,CAAC;AAElB,cAAc,UAAU,CAAC;AAEzB,eAAO,MAAM,gBAAgB,iBAAsB,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC;AAG7D,wBAAgB,aAAa,CAC3B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;;kCA0BR,iBAAiB,GAAG,iBAAiB,eAAe,CAAC,KACjE,eAAe;uCAuCH,iBAAiB,GAC5B,SAAS,iBAAiB,qBAAqB,CAAC,CAAC,KAClD,qBAAqB;kCAtBT,iBAAiB,GAAG,iBAAiB,eAAe,CAAC,KACjE,eAAe;IAmDhB;;;;;;;OAOG;2DAIA,4BAA4B,GAAG,MAAM;IASxC;;;;;;OAMG;0DAGA,wCAAwC,GAAG,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAcvD"}
|