algoliasearch 5.0.0-alpha.53 → 5.0.0-alpha.54
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/algoliasearch/builds/models.d.ts +31 -31
- package/dist/algoliasearch/jest.config.d.ts +3 -3
- package/dist/algoliasearch.cjs.js +3487 -3485
- package/dist/algoliasearch.esm.browser.js +3620 -3618
- package/dist/algoliasearch.esm.node.js +3487 -3485
- package/dist/algoliasearch.umd.js +2 -2
- package/dist/builds/browser.d.ts +87 -87
- package/dist/builds/node.d.ts +87 -87
- package/dist/client-abtesting/model/aBTest.d.ts +39 -39
- package/dist/client-abtesting/model/aBTestResponse.d.ts +14 -14
- package/dist/client-abtesting/model/abTestsVariant.d.ts +14 -14
- package/dist/client-abtesting/model/abTestsVariantSearchParams.d.ts +3 -3
- package/dist/client-abtesting/model/addABTestsRequest.d.ts +15 -15
- package/dist/client-abtesting/model/addABTestsVariant.d.ts +3 -3
- package/dist/client-abtesting/model/clientMethodProps.d.ts +100 -100
- package/dist/client-abtesting/model/customSearchParams.d.ts +3 -3
- package/dist/client-abtesting/model/errorBase.d.ts +6 -6
- package/dist/client-abtesting/model/index.d.ts +11 -11
- package/dist/client-abtesting/model/listABTestsResponse.d.ts +15 -15
- package/dist/client-abtesting/model/variant.d.ts +50 -50
- package/dist/client-abtesting/src/abtestingClient.d.ts +124 -124
- package/dist/client-analytics/model/averageClickEvent.d.ts +14 -14
- package/dist/client-analytics/model/clickPosition.d.ts +10 -10
- package/dist/client-analytics/model/clickThroughRateEvent.d.ts +18 -18
- package/dist/client-analytics/model/clientMethodProps.d.ts +507 -507
- package/dist/client-analytics/model/conversionRateEvent.d.ts +18 -18
- package/dist/client-analytics/model/direction.d.ts +1 -1
- package/dist/client-analytics/model/errorBase.d.ts +6 -6
- package/dist/client-analytics/model/getAverageClickPositionResponse.d.ts +15 -15
- package/dist/client-analytics/model/getClickPositionsResponse.d.ts +7 -7
- package/dist/client-analytics/model/getClickThroughRateResponse.d.ts +19 -19
- package/dist/client-analytics/model/getConversationRateResponse.d.ts +19 -19
- package/dist/client-analytics/model/getNoClickRateResponse.d.ts +19 -19
- package/dist/client-analytics/model/getNoResultsRateResponse.d.ts +19 -19
- package/dist/client-analytics/model/getSearchesCountResponse.d.ts +11 -11
- package/dist/client-analytics/model/getSearchesNoClicksResponse.d.ts +7 -7
- package/dist/client-analytics/model/getSearchesNoResultsResponse.d.ts +7 -7
- package/dist/client-analytics/model/getStatusResponse.d.ts +6 -6
- package/dist/client-analytics/model/getTopCountriesResponse.d.ts +7 -7
- package/dist/client-analytics/model/getTopFilterAttribute.d.ts +10 -10
- package/dist/client-analytics/model/getTopFilterAttributesResponse.d.ts +7 -7
- package/dist/client-analytics/model/getTopFilterForAttribute.d.ts +18 -18
- package/dist/client-analytics/model/getTopFilterForAttributeResponse.d.ts +7 -7
- package/dist/client-analytics/model/getTopFiltersNoResultsResponse.d.ts +7 -7
- package/dist/client-analytics/model/getTopFiltersNoResultsValue.d.ts +14 -14
- package/dist/client-analytics/model/getTopFiltersNoResultsValues.d.ts +11 -11
- package/dist/client-analytics/model/getTopHitsResponse.d.ts +3 -3
- package/dist/client-analytics/model/getTopSearchesResponse.d.ts +3 -3
- package/dist/client-analytics/model/getUsersCountResponse.d.ts +11 -11
- package/dist/client-analytics/model/index.d.ts +44 -44
- package/dist/client-analytics/model/noClickRateEvent.d.ts +18 -18
- package/dist/client-analytics/model/noResultsRateEvent.d.ts +18 -18
- package/dist/client-analytics/model/orderBy.d.ts +1 -1
- package/dist/client-analytics/model/searchEvent.d.ts +10 -10
- package/dist/client-analytics/model/searchNoClickEvent.d.ts +14 -14
- package/dist/client-analytics/model/searchNoResultEvent.d.ts +14 -14
- package/dist/client-analytics/model/topCountry.d.ts +10 -10
- package/dist/client-analytics/model/topHit.d.ts +10 -10
- package/dist/client-analytics/model/topHitWithAnalytics.d.ts +30 -30
- package/dist/client-analytics/model/topHitsResponse.d.ts +7 -7
- package/dist/client-analytics/model/topHitsResponseWithAnalytics.d.ts +7 -7
- package/dist/client-analytics/model/topSearch.d.ts +14 -14
- package/dist/client-analytics/model/topSearchWithAnalytics.d.ts +38 -38
- package/dist/client-analytics/model/topSearchesResponse.d.ts +7 -7
- package/dist/client-analytics/model/topSearchesResponseWithAnalytics.d.ts +7 -7
- package/dist/client-analytics/model/userWithDate.d.ts +10 -10
- package/dist/client-analytics/src/analyticsClient.d.ts +318 -318
- package/dist/client-personalization/model/clientMethodProps.d.ts +78 -78
- package/dist/client-personalization/model/deleteUserProfileResponse.d.ts +10 -10
- package/dist/client-personalization/model/errorBase.d.ts +6 -6
- package/dist/client-personalization/model/eventScoring.d.ts +14 -14
- package/dist/client-personalization/model/facetScoring.d.ts +10 -10
- package/dist/client-personalization/model/getUserTokenResponse.d.ts +14 -14
- package/dist/client-personalization/model/index.d.ts +8 -8
- package/dist/client-personalization/model/personalizationStrategyParams.d.ts +16 -16
- package/dist/client-personalization/model/setPersonalizationStrategyResponse.d.ts +6 -6
- package/dist/client-personalization/src/personalizationClient.d.ts +112 -112
- package/dist/client-search/model/acl.d.ts +4 -4
- package/dist/client-search/model/action.d.ts +4 -4
- package/dist/client-search/model/addApiKeyResponse.d.ts +10 -10
- package/dist/client-search/model/advancedSyntaxFeatures.d.ts +1 -1
- package/dist/client-search/model/alternativesAsExact.d.ts +1 -1
- package/dist/client-search/model/anchoring.d.ts +4 -4
- package/dist/client-search/model/apiKey.d.ts +38 -38
- package/dist/client-search/model/aroundRadius.d.ts +5 -5
- package/dist/client-search/model/aroundRadiusAll.d.ts +1 -1
- package/dist/client-search/model/assignUserIdParams.d.ts +9 -9
- package/dist/client-search/model/attributeToUpdate.d.ts +2 -2
- package/dist/client-search/model/automaticFacetFilter.d.ts +17 -17
- package/dist/client-search/model/automaticFacetFilters.d.ts +5 -5
- package/dist/client-search/model/baseGetApiKeyResponse.d.ts +10 -10
- package/dist/client-search/model/baseIndexSettings.d.ts +62 -62
- package/dist/client-search/model/baseSearchParams.d.ts +3 -3
- package/dist/client-search/model/baseSearchParamsWithoutQuery.d.ts +122 -122
- package/dist/client-search/model/baseSearchResponse.d.ts +101 -101
- package/dist/client-search/model/batchAssignUserIdsParams.d.ts +13 -13
- package/dist/client-search/model/batchDictionaryEntriesParams.d.ts +14 -14
- package/dist/client-search/model/batchDictionaryEntriesRequest.d.ts +6 -6
- package/dist/client-search/model/batchParams.d.ts +7 -7
- package/dist/client-search/model/batchRequest.d.ts +8 -8
- package/dist/client-search/model/batchResponse.d.ts +10 -10
- package/dist/client-search/model/batchWriteParams.d.ts +7 -7
- package/dist/client-search/model/browseParams.d.ts +3 -3
- package/dist/client-search/model/browseParamsObject.d.ts +3 -3
- package/dist/client-search/model/browseResponse.d.ts +4 -4
- package/dist/client-search/model/builtInOperation.d.ts +11 -11
- package/dist/client-search/model/builtInOperationType.d.ts +4 -4
- package/dist/client-search/model/clientMethodProps.d.ts +715 -715
- package/dist/client-search/model/condition.d.ts +16 -16
- package/dist/client-search/model/consequence.d.ts +25 -25
- package/dist/client-search/model/consequenceHide.d.ts +9 -9
- package/dist/client-search/model/consequenceParams.d.ts +4 -4
- package/dist/client-search/model/consequenceQuery.d.ts +5 -5
- package/dist/client-search/model/consequenceQueryObject.d.ts +11 -11
- package/dist/client-search/model/createdAtResponse.d.ts +9 -9
- package/dist/client-search/model/cursor.d.ts +6 -6
- package/dist/client-search/model/deleteApiKeyResponse.d.ts +6 -6
- package/dist/client-search/model/deleteByParams.d.ts +26 -26
- package/dist/client-search/model/deleteSourceResponse.d.ts +6 -6
- package/dist/client-search/model/deletedAtResponse.d.ts +13 -13
- package/dist/client-search/model/dictionaryAction.d.ts +4 -4
- package/dist/client-search/model/dictionaryEntry.d.ts +27 -27
- package/dist/client-search/model/dictionaryEntryState.d.ts +4 -4
- package/dist/client-search/model/dictionaryLanguage.d.ts +9 -9
- package/dist/client-search/model/dictionarySettingsParams.d.ts +7 -7
- package/dist/client-search/model/dictionaryType.d.ts +1 -1
- package/dist/client-search/model/distinct.d.ts +4 -4
- package/dist/client-search/model/edit.d.ts +12 -12
- package/dist/client-search/model/editType.d.ts +4 -4
- package/dist/client-search/model/errorBase.d.ts +6 -6
- package/dist/client-search/model/exactOnSingleWordQuery.d.ts +4 -4
- package/dist/client-search/model/facetFilters.d.ts +5 -5
- package/dist/client-search/model/facetHits.d.ts +14 -14
- package/dist/client-search/model/facetOrdering.d.ts +12 -12
- package/dist/client-search/model/facets.d.ts +9 -9
- package/dist/client-search/model/facetsStats.d.ts +18 -18
- package/dist/client-search/model/fetchedIndex.d.ts +46 -46
- package/dist/client-search/model/getApiKeyResponse.d.ts +3 -3
- package/dist/client-search/model/getDictionarySettingsResponse.d.ts +4 -4
- package/dist/client-search/model/getLogsResponse.d.ts +4 -4
- package/dist/client-search/model/getObjectsParams.d.ts +7 -7
- package/dist/client-search/model/getObjectsRequest.d.ts +17 -17
- package/dist/client-search/model/getObjectsResponse.d.ts +6 -6
- package/dist/client-search/model/getTaskResponse.d.ts +4 -4
- package/dist/client-search/model/getTopUserIdsResponse.d.ts +10 -10
- package/dist/client-search/model/hasPendingMappingsResponse.d.ts +10 -10
- package/dist/client-search/model/highlightResult.d.ts +2 -2
- package/dist/client-search/model/highlightResultOption.d.ts +19 -19
- package/dist/client-search/model/hit.d.ts +22 -22
- package/dist/client-search/model/ignorePlurals.d.ts +4 -4
- package/dist/client-search/model/index.d.ts +154 -154
- package/dist/client-search/model/indexSettings.d.ts +6 -6
- package/dist/client-search/model/indexSettingsAsSearchParams.d.ts +156 -156
- package/dist/client-search/model/languages.d.ts +9 -9
- package/dist/client-search/model/listApiKeysResponse.d.ts +7 -7
- package/dist/client-search/model/listClustersResponse.d.ts +9 -9
- package/dist/client-search/model/listIndicesResponse.d.ts +11 -11
- package/dist/client-search/model/listUserIdsResponse.d.ts +10 -10
- package/dist/client-search/model/log.d.ts +63 -63
- package/dist/client-search/model/logQuery.d.ts +14 -14
- package/dist/client-search/model/logType.d.ts +1 -1
- package/dist/client-search/model/matchLevel.d.ts +4 -4
- package/dist/client-search/model/matchedGeoLocation.d.ts +14 -14
- package/dist/client-search/model/mixedSearchFilters.d.ts +1 -1
- package/dist/client-search/model/multipleBatchRequest.d.ts +12 -12
- package/dist/client-search/model/multipleBatchResponse.d.ts +10 -10
- package/dist/client-search/model/numericFilters.d.ts +5 -5
- package/dist/client-search/model/operationIndexParams.d.ts +13 -13
- package/dist/client-search/model/operationType.d.ts +4 -4
- package/dist/client-search/model/optionalFilters.d.ts +5 -5
- package/dist/client-search/model/params.d.ts +12 -12
- package/dist/client-search/model/personalization.d.ts +14 -14
- package/dist/client-search/model/promote.d.ts +3 -3
- package/dist/client-search/model/promoteObjectID.d.ts +13 -13
- package/dist/client-search/model/promoteObjectIDs.d.ts +13 -13
- package/dist/client-search/model/queryType.d.ts +4 -4
- package/dist/client-search/model/rankingInfo.d.ts +50 -50
- package/dist/client-search/model/reRankingApplyFilter.d.ts +5 -5
- package/dist/client-search/model/removeStopWords.d.ts +4 -4
- package/dist/client-search/model/removeUserIdResponse.d.ts +6 -6
- package/dist/client-search/model/removeWordsIfNoResults.d.ts +4 -4
- package/dist/client-search/model/renderingContent.d.ts +7 -7
- package/dist/client-search/model/replaceSourceResponse.d.ts +6 -6
- package/dist/client-search/model/rule.d.ts +29 -29
- package/dist/client-search/model/saveObjectResponse.d.ts +11 -11
- package/dist/client-search/model/saveSynonymResponse.d.ts +14 -14
- package/dist/client-search/model/scopeType.d.ts +1 -1
- package/dist/client-search/model/searchDictionaryEntriesParams.d.ts +21 -21
- package/dist/client-search/model/searchForFacetValuesRequest.d.ts +14 -14
- package/dist/client-search/model/searchForFacetValuesResponse.d.ts +4 -4
- package/dist/client-search/model/searchForFacets.d.ts +3 -3
- package/dist/client-search/model/searchForFacetsOptions.d.ts +20 -20
- package/dist/client-search/model/searchForHits.d.ts +3 -3
- package/dist/client-search/model/searchForHitsOptions.d.ts +12 -12
- package/dist/client-search/model/searchHits.d.ts +4 -4
- package/dist/client-search/model/searchMethodParams.d.ts +6 -6
- package/dist/client-search/model/searchParams.d.ts +3 -3
- package/dist/client-search/model/searchParamsObject.d.ts +3 -3
- package/dist/client-search/model/searchParamsQuery.d.ts +6 -6
- package/dist/client-search/model/searchParamsString.d.ts +6 -6
- package/dist/client-search/model/searchQuery.d.ts +3 -3
- package/dist/client-search/model/searchResponse.d.ts +3 -3
- package/dist/client-search/model/searchResponses.d.ts +4 -4
- package/dist/client-search/model/searchRulesParams.d.ts +31 -31
- package/dist/client-search/model/searchRulesResponse.d.ts +19 -19
- package/dist/client-search/model/searchStrategy.d.ts +1 -1
- package/dist/client-search/model/searchSynonymsParams.d.ts +6 -6
- package/dist/client-search/model/searchSynonymsResponse.d.ts +11 -11
- package/dist/client-search/model/searchTypeDefault.d.ts +4 -4
- package/dist/client-search/model/searchTypeFacet.d.ts +4 -4
- package/dist/client-search/model/searchUserIdsParams.d.ts +21 -21
- package/dist/client-search/model/searchUserIdsResponse.d.ts +26 -26
- package/dist/client-search/model/snippetResult.d.ts +2 -2
- package/dist/client-search/model/snippetResultOption.d.ts +11 -11
- package/dist/client-search/model/sortRemainingBy.d.ts +4 -4
- package/dist/client-search/model/source.d.ts +13 -13
- package/dist/client-search/model/standardEntries.d.ts +17 -17
- package/dist/client-search/model/synonymHit.d.ts +35 -35
- package/dist/client-search/model/synonymType.d.ts +4 -4
- package/dist/client-search/model/tagFilters.d.ts +5 -5
- package/dist/client-search/model/taskStatus.d.ts +1 -1
- package/dist/client-search/model/timeRange.d.ts +10 -10
- package/dist/client-search/model/typoTolerance.d.ts +5 -5
- package/dist/client-search/model/typoToleranceEnum.d.ts +1 -1
- package/dist/client-search/model/updateApiKeyResponse.d.ts +10 -10
- package/dist/client-search/model/updatedAtResponse.d.ts +13 -13
- package/dist/client-search/model/updatedAtWithObjectIdResponse.d.ts +17 -17
- package/dist/client-search/model/updatedRuleResponse.d.ts +14 -14
- package/dist/client-search/model/userHighlightResult.d.ts +11 -11
- package/dist/client-search/model/userHit.d.ts +24 -24
- package/dist/client-search/model/userId.d.ts +21 -21
- package/dist/client-search/model/value.d.ts +8 -8
- package/dist/client-search/src/searchClient.d.ts +723 -723
- package/dist/lite/builds/browser.d.ts +5 -5
- package/dist/lite/builds/node.d.ts +5 -5
- package/dist/lite/lite.cjs.js +183 -183
- package/dist/lite/lite.esm.browser.js +307 -307
- package/dist/lite/lite.esm.node.js +183 -183
- package/dist/lite/lite.umd.js +2 -2
- package/dist/lite/model/acl.d.ts +4 -4
- package/dist/lite/model/action.d.ts +4 -4
- package/dist/lite/model/addApiKeyResponse.d.ts +10 -10
- package/dist/lite/model/advancedSyntaxFeatures.d.ts +1 -1
- package/dist/lite/model/alternativesAsExact.d.ts +1 -1
- package/dist/lite/model/anchoring.d.ts +4 -4
- package/dist/lite/model/apiKey.d.ts +38 -38
- package/dist/lite/model/aroundRadius.d.ts +5 -5
- package/dist/lite/model/aroundRadiusAll.d.ts +1 -1
- package/dist/lite/model/attributeToUpdate.d.ts +2 -2
- package/dist/lite/model/automaticFacetFilter.d.ts +17 -17
- package/dist/lite/model/automaticFacetFilters.d.ts +5 -5
- package/dist/lite/model/baseGetApiKeyResponse.d.ts +10 -10
- package/dist/lite/model/baseIndexSettings.d.ts +62 -62
- package/dist/lite/model/baseSearchParams.d.ts +3 -3
- package/dist/lite/model/baseSearchParamsWithoutQuery.d.ts +122 -122
- package/dist/lite/model/baseSearchResponse.d.ts +101 -101
- package/dist/lite/model/browseParams.d.ts +3 -3
- package/dist/lite/model/browseParamsObject.d.ts +3 -3
- package/dist/lite/model/browseResponse.d.ts +4 -4
- package/dist/lite/model/builtInOperation.d.ts +11 -11
- package/dist/lite/model/builtInOperationType.d.ts +4 -4
- package/dist/lite/model/clientMethodProps.d.ts +48 -48
- package/dist/lite/model/condition.d.ts +16 -16
- package/dist/lite/model/consequence.d.ts +25 -25
- package/dist/lite/model/consequenceHide.d.ts +9 -9
- package/dist/lite/model/consequenceParams.d.ts +4 -4
- package/dist/lite/model/consequenceQuery.d.ts +5 -5
- package/dist/lite/model/consequenceQueryObject.d.ts +11 -11
- package/dist/lite/model/cursor.d.ts +6 -6
- package/dist/lite/model/deleteByParams.d.ts +26 -26
- package/dist/lite/model/dictionaryAction.d.ts +4 -4
- package/dist/lite/model/dictionaryEntry.d.ts +27 -27
- package/dist/lite/model/dictionaryEntryState.d.ts +4 -4
- package/dist/lite/model/dictionaryLanguage.d.ts +9 -9
- package/dist/lite/model/dictionaryType.d.ts +1 -1
- package/dist/lite/model/distinct.d.ts +4 -4
- package/dist/lite/model/edit.d.ts +12 -12
- package/dist/lite/model/editType.d.ts +4 -4
- package/dist/lite/model/errorBase.d.ts +6 -6
- package/dist/lite/model/exactOnSingleWordQuery.d.ts +4 -4
- package/dist/lite/model/facetFilters.d.ts +5 -5
- package/dist/lite/model/facetOrdering.d.ts +12 -12
- package/dist/lite/model/facets.d.ts +9 -9
- package/dist/lite/model/facetsStats.d.ts +18 -18
- package/dist/lite/model/fetchedIndex.d.ts +46 -46
- package/dist/lite/model/getApiKeyResponse.d.ts +3 -3
- package/dist/lite/model/highlightResult.d.ts +2 -2
- package/dist/lite/model/highlightResultOption.d.ts +19 -19
- package/dist/lite/model/hit.d.ts +22 -22
- package/dist/lite/model/ignorePlurals.d.ts +4 -4
- package/dist/lite/model/index.d.ts +107 -107
- package/dist/lite/model/indexSettings.d.ts +6 -6
- package/dist/lite/model/indexSettingsAsSearchParams.d.ts +156 -156
- package/dist/lite/model/languages.d.ts +9 -9
- package/dist/lite/model/listIndicesResponse.d.ts +11 -11
- package/dist/lite/model/logType.d.ts +1 -1
- package/dist/lite/model/matchLevel.d.ts +4 -4
- package/dist/lite/model/matchedGeoLocation.d.ts +14 -14
- package/dist/lite/model/mixedSearchFilters.d.ts +1 -1
- package/dist/lite/model/numericFilters.d.ts +5 -5
- package/dist/lite/model/operationType.d.ts +4 -4
- package/dist/lite/model/optionalFilters.d.ts +5 -5
- package/dist/lite/model/params.d.ts +12 -12
- package/dist/lite/model/personalization.d.ts +14 -14
- package/dist/lite/model/promote.d.ts +3 -3
- package/dist/lite/model/promoteObjectID.d.ts +13 -13
- package/dist/lite/model/promoteObjectIDs.d.ts +13 -13
- package/dist/lite/model/queryType.d.ts +4 -4
- package/dist/lite/model/rankingInfo.d.ts +50 -50
- package/dist/lite/model/reRankingApplyFilter.d.ts +5 -5
- package/dist/lite/model/removeStopWords.d.ts +4 -4
- package/dist/lite/model/removeWordsIfNoResults.d.ts +4 -4
- package/dist/lite/model/renderingContent.d.ts +7 -7
- package/dist/lite/model/rule.d.ts +29 -29
- package/dist/lite/model/scopeType.d.ts +1 -1
- package/dist/lite/model/searchForFacets.d.ts +3 -3
- package/dist/lite/model/searchForFacetsOptions.d.ts +20 -20
- package/dist/lite/model/searchForHits.d.ts +3 -3
- package/dist/lite/model/searchForHitsOptions.d.ts +12 -12
- package/dist/lite/model/searchHits.d.ts +4 -4
- package/dist/lite/model/searchMethodParams.d.ts +6 -6
- package/dist/lite/model/searchParams.d.ts +3 -3
- package/dist/lite/model/searchParamsObject.d.ts +3 -3
- package/dist/lite/model/searchParamsQuery.d.ts +6 -6
- package/dist/lite/model/searchParamsString.d.ts +6 -6
- package/dist/lite/model/searchQuery.d.ts +3 -3
- package/dist/lite/model/searchResponse.d.ts +3 -3
- package/dist/lite/model/searchResponses.d.ts +4 -4
- package/dist/lite/model/searchStrategy.d.ts +1 -1
- package/dist/lite/model/searchSynonymsResponse.d.ts +11 -11
- package/dist/lite/model/searchTypeDefault.d.ts +4 -4
- package/dist/lite/model/searchTypeFacet.d.ts +4 -4
- package/dist/lite/model/snippetResult.d.ts +2 -2
- package/dist/lite/model/snippetResultOption.d.ts +11 -11
- package/dist/lite/model/sortRemainingBy.d.ts +4 -4
- package/dist/lite/model/source.d.ts +13 -13
- package/dist/lite/model/standardEntries.d.ts +17 -17
- package/dist/lite/model/synonymHit.d.ts +35 -35
- package/dist/lite/model/synonymType.d.ts +4 -4
- package/dist/lite/model/tagFilters.d.ts +5 -5
- package/dist/lite/model/taskStatus.d.ts +1 -1
- package/dist/lite/model/timeRange.d.ts +10 -10
- package/dist/lite/model/typoTolerance.d.ts +5 -5
- package/dist/lite/model/typoToleranceEnum.d.ts +1 -1
- package/dist/lite/model/updatedRuleResponse.d.ts +14 -14
- package/dist/lite/model/userId.d.ts +21 -21
- package/dist/lite/model/value.d.ts +8 -8
- package/dist/lite/src/liteClient.d.ts +50 -50
- package/lite/src/liteClient.ts +1 -1
- package/package.json +12 -12
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Type of the synonym object.
|
|
3
|
-
*/
|
|
4
|
-
export type SynonymType = 'altcorrection1' | 'altcorrection2' | 'onewaysynonym' | 'placeholder' | 'synonym';
|
|
1
|
+
/**
|
|
2
|
+
* Type of the synonym object.
|
|
3
|
+
*/
|
|
4
|
+
export type SynonymType = 'altcorrection1' | 'altcorrection2' | 'onewaysynonym' | 'placeholder' | 'synonym';
|
|
5
5
|
//# sourceMappingURL=synonymType.d.ts.map
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import type { MixedSearchFilters } from './mixedSearchFilters';
|
|
2
|
-
/**
|
|
3
|
-
* Filter hits by tags.
|
|
4
|
-
*/
|
|
5
|
-
export type TagFilters = MixedSearchFilters[] | string;
|
|
1
|
+
import type { MixedSearchFilters } from './mixedSearchFilters';
|
|
2
|
+
/**
|
|
3
|
+
* Filter hits by tags.
|
|
4
|
+
*/
|
|
5
|
+
export type TagFilters = MixedSearchFilters[] | string;
|
|
6
6
|
//# sourceMappingURL=tagFilters.d.ts.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export type TaskStatus = 'notPublished' | 'published';
|
|
1
|
+
export type TaskStatus = 'notPublished' | 'published';
|
|
2
2
|
//# sourceMappingURL=taskStatus.d.ts.map
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
export type TimeRange = {
|
|
2
|
-
/**
|
|
3
|
-
* Lower bound of the time range (Unix timestamp).
|
|
4
|
-
*/
|
|
5
|
-
from: number;
|
|
6
|
-
/**
|
|
7
|
-
* Upper bound of the time range (Unix timestamp).
|
|
8
|
-
*/
|
|
9
|
-
until: number;
|
|
10
|
-
};
|
|
1
|
+
export type TimeRange = {
|
|
2
|
+
/**
|
|
3
|
+
* Lower bound of the time range (Unix timestamp).
|
|
4
|
+
*/
|
|
5
|
+
from: number;
|
|
6
|
+
/**
|
|
7
|
+
* Upper bound of the time range (Unix timestamp).
|
|
8
|
+
*/
|
|
9
|
+
until: number;
|
|
10
|
+
};
|
|
11
11
|
//# sourceMappingURL=timeRange.d.ts.map
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import type { TypoToleranceEnum } from './typoToleranceEnum';
|
|
2
|
-
/**
|
|
3
|
-
* Controls whether typo tolerance is enabled and how it is applied.
|
|
4
|
-
*/
|
|
5
|
-
export type TypoTolerance = TypoToleranceEnum | boolean;
|
|
1
|
+
import type { TypoToleranceEnum } from './typoToleranceEnum';
|
|
2
|
+
/**
|
|
3
|
+
* Controls whether typo tolerance is enabled and how it is applied.
|
|
4
|
+
*/
|
|
5
|
+
export type TypoTolerance = TypoToleranceEnum | boolean;
|
|
6
6
|
//# sourceMappingURL=typoTolerance.d.ts.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export type TypoToleranceEnum = 'min' | 'strict';
|
|
1
|
+
export type TypoToleranceEnum = 'min' | 'strict';
|
|
2
2
|
//# sourceMappingURL=typoToleranceEnum.d.ts.map
|
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
export type UpdatedRuleResponse = {
|
|
2
|
-
/**
|
|
3
|
-
* Unique identifier of the object.
|
|
4
|
-
*/
|
|
5
|
-
objectID: string;
|
|
6
|
-
/**
|
|
7
|
-
* Date of last update (ISO-8601 format).
|
|
8
|
-
*/
|
|
9
|
-
updatedAt: string;
|
|
10
|
-
/**
|
|
11
|
-
* TaskID of the task to wait for.
|
|
12
|
-
*/
|
|
13
|
-
taskID: number;
|
|
14
|
-
};
|
|
1
|
+
export type UpdatedRuleResponse = {
|
|
2
|
+
/**
|
|
3
|
+
* Unique identifier of the object.
|
|
4
|
+
*/
|
|
5
|
+
objectID: string;
|
|
6
|
+
/**
|
|
7
|
+
* Date of last update (ISO-8601 format).
|
|
8
|
+
*/
|
|
9
|
+
updatedAt: string;
|
|
10
|
+
/**
|
|
11
|
+
* TaskID of the task to wait for.
|
|
12
|
+
*/
|
|
13
|
+
taskID: number;
|
|
14
|
+
};
|
|
15
15
|
//# sourceMappingURL=updatedRuleResponse.d.ts.map
|
|
@@ -1,22 +1,22 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* A userID.
|
|
3
|
-
*/
|
|
4
|
-
export type UserId = {
|
|
5
|
-
/**
|
|
6
|
-
* UserID of the user.
|
|
7
|
-
*/
|
|
8
|
-
userID: string;
|
|
9
|
-
/**
|
|
10
|
-
* Cluster on which the user is assigned.
|
|
11
|
-
*/
|
|
12
|
-
clusterName: string;
|
|
13
|
-
/**
|
|
14
|
-
* Number of records belonging to the user.
|
|
15
|
-
*/
|
|
16
|
-
nbRecords: number;
|
|
17
|
-
/**
|
|
18
|
-
* Data size used by the user.
|
|
19
|
-
*/
|
|
20
|
-
dataSize: number;
|
|
21
|
-
};
|
|
1
|
+
/**
|
|
2
|
+
* A userID.
|
|
3
|
+
*/
|
|
4
|
+
export type UserId = {
|
|
5
|
+
/**
|
|
6
|
+
* UserID of the user.
|
|
7
|
+
*/
|
|
8
|
+
userID: string;
|
|
9
|
+
/**
|
|
10
|
+
* Cluster on which the user is assigned.
|
|
11
|
+
*/
|
|
12
|
+
clusterName: string;
|
|
13
|
+
/**
|
|
14
|
+
* Number of records belonging to the user.
|
|
15
|
+
*/
|
|
16
|
+
nbRecords: number;
|
|
17
|
+
/**
|
|
18
|
+
* Data size used by the user.
|
|
19
|
+
*/
|
|
20
|
+
dataSize: number;
|
|
21
|
+
};
|
|
22
22
|
//# sourceMappingURL=userId.d.ts.map
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
import type { SortRemainingBy } from './sortRemainingBy';
|
|
2
|
-
export type Value = {
|
|
3
|
-
/**
|
|
4
|
-
* Pinned order of facet lists.
|
|
5
|
-
*/
|
|
6
|
-
order?: string[];
|
|
7
|
-
sortRemainingBy?: SortRemainingBy;
|
|
8
|
-
};
|
|
1
|
+
import type { SortRemainingBy } from './sortRemainingBy';
|
|
2
|
+
export type Value = {
|
|
3
|
+
/**
|
|
4
|
+
* Pinned order of facet lists.
|
|
5
|
+
*/
|
|
6
|
+
order?: string[];
|
|
7
|
+
sortRemainingBy?: SortRemainingBy;
|
|
8
|
+
};
|
|
9
9
|
//# sourceMappingURL=value.d.ts.map
|
|
@@ -1,51 +1,51 @@
|
|
|
1
|
-
import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
|
|
2
|
-
import type { PostProps, LegacySearchMethodProps } from '../model/clientMethodProps';
|
|
3
|
-
import type { SearchMethodParams } from '../model/searchMethodParams';
|
|
4
|
-
import type { SearchResponses } from '../model/searchResponses';
|
|
5
|
-
export declare const apiClientVersion = "5.0.0-alpha.
|
|
6
|
-
export declare function createLiteClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
|
|
7
|
-
transporter: import("@algolia/client-common").Transporter;
|
|
8
|
-
/**
|
|
9
|
-
* The `appId` currently in use.
|
|
10
|
-
*/
|
|
11
|
-
appId: string;
|
|
12
|
-
/**
|
|
13
|
-
* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
|
|
14
|
-
*/
|
|
15
|
-
clearCache(): Promise<void>;
|
|
16
|
-
/**
|
|
17
|
-
* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
|
|
18
|
-
*/
|
|
19
|
-
readonly _ua: string;
|
|
20
|
-
/**
|
|
21
|
-
* Adds a `segment` to the `x-algolia-agent` sent with every requests.
|
|
22
|
-
*
|
|
23
|
-
* @param segment - The algolia agent (user-agent) segment to add.
|
|
24
|
-
* @param version - The version of the agent.
|
|
25
|
-
*/
|
|
26
|
-
addAlgoliaAgent(segment: string, version?: string): void;
|
|
27
|
-
/**
|
|
28
|
-
* This method allow you to send requests to the Algolia REST API.
|
|
29
|
-
*
|
|
30
|
-
* @summary Send requests to the Algolia REST API.
|
|
31
|
-
* @param post - The post object.
|
|
32
|
-
* @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
|
|
33
|
-
* @param post.parameters - Query parameters to be applied to the current query.
|
|
34
|
-
* @param post.body - The parameters to send with the custom request.
|
|
35
|
-
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
36
|
-
*/
|
|
37
|
-
post({ path, parameters, body }: PostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
38
|
-
/**
|
|
39
|
-
* Perform a search operation targeting one or many indices.
|
|
40
|
-
*
|
|
41
|
-
* @summary Search multiple indices.
|
|
42
|
-
* @param searchMethodParams - The `search` requests and strategy.
|
|
43
|
-
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
44
|
-
*/
|
|
45
|
-
search<T>(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: RequestOptions): Promise<SearchResponses<T>>;
|
|
46
|
-
};
|
|
47
|
-
/**
|
|
48
|
-
* The client type.
|
|
49
|
-
*/
|
|
50
|
-
export type LiteClient = ReturnType<typeof createLiteClient>;
|
|
1
|
+
import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
|
|
2
|
+
import type { PostProps, LegacySearchMethodProps } from '../model/clientMethodProps';
|
|
3
|
+
import type { SearchMethodParams } from '../model/searchMethodParams';
|
|
4
|
+
import type { SearchResponses } from '../model/searchResponses';
|
|
5
|
+
export declare const apiClientVersion = "5.0.0-alpha.54";
|
|
6
|
+
export declare function createLiteClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
|
|
7
|
+
transporter: import("@algolia/client-common").Transporter;
|
|
8
|
+
/**
|
|
9
|
+
* The `appId` currently in use.
|
|
10
|
+
*/
|
|
11
|
+
appId: string;
|
|
12
|
+
/**
|
|
13
|
+
* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
|
|
14
|
+
*/
|
|
15
|
+
clearCache(): Promise<void>;
|
|
16
|
+
/**
|
|
17
|
+
* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
|
|
18
|
+
*/
|
|
19
|
+
readonly _ua: string;
|
|
20
|
+
/**
|
|
21
|
+
* Adds a `segment` to the `x-algolia-agent` sent with every requests.
|
|
22
|
+
*
|
|
23
|
+
* @param segment - The algolia agent (user-agent) segment to add.
|
|
24
|
+
* @param version - The version of the agent.
|
|
25
|
+
*/
|
|
26
|
+
addAlgoliaAgent(segment: string, version?: string): void;
|
|
27
|
+
/**
|
|
28
|
+
* This method allow you to send requests to the Algolia REST API.
|
|
29
|
+
*
|
|
30
|
+
* @summary Send requests to the Algolia REST API.
|
|
31
|
+
* @param post - The post object.
|
|
32
|
+
* @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
|
|
33
|
+
* @param post.parameters - Query parameters to be applied to the current query.
|
|
34
|
+
* @param post.body - The parameters to send with the custom request.
|
|
35
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
36
|
+
*/
|
|
37
|
+
post({ path, parameters, body }: PostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
38
|
+
/**
|
|
39
|
+
* Perform a search operation targeting one or many indices.
|
|
40
|
+
*
|
|
41
|
+
* @summary Search multiple indices.
|
|
42
|
+
* @param searchMethodParams - The `search` requests and strategy.
|
|
43
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
44
|
+
*/
|
|
45
|
+
search<T>(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: RequestOptions): Promise<SearchResponses<T>>;
|
|
46
|
+
};
|
|
47
|
+
/**
|
|
48
|
+
* The client type.
|
|
49
|
+
*/
|
|
50
|
+
export type LiteClient = ReturnType<typeof createLiteClient>;
|
|
51
51
|
//# sourceMappingURL=liteClient.d.ts.map
|
package/lite/src/liteClient.ts
CHANGED
|
@@ -22,7 +22,7 @@ import type {
|
|
|
22
22
|
import type { SearchMethodParams } from '../model/searchMethodParams';
|
|
23
23
|
import type { SearchResponses } from '../model/searchResponses';
|
|
24
24
|
|
|
25
|
-
export const apiClientVersion = '5.0.0-alpha.
|
|
25
|
+
export const apiClientVersion = '5.0.0-alpha.54';
|
|
26
26
|
|
|
27
27
|
function getDefaultHosts(appId: string): Host[] {
|
|
28
28
|
return (
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "algoliasearch",
|
|
3
|
-
"version": "5.0.0-alpha.
|
|
3
|
+
"version": "5.0.0-alpha.54",
|
|
4
4
|
"description": "A fully-featured and blazing-fast JavaScript API client to interact with Algolia API.",
|
|
5
5
|
"repository": "algolia/algoliasearch-client-javascript",
|
|
6
6
|
"license": "MIT",
|
|
@@ -59,21 +59,21 @@
|
|
|
59
59
|
"test": "jest"
|
|
60
60
|
},
|
|
61
61
|
"dependencies": {
|
|
62
|
-
"@algolia/client-abtesting": "5.0.0-alpha.
|
|
63
|
-
"@algolia/client-analytics": "5.0.0-alpha.
|
|
64
|
-
"@algolia/client-common": "5.0.0-alpha.
|
|
65
|
-
"@algolia/client-personalization": "5.0.0-alpha.
|
|
66
|
-
"@algolia/client-search": "5.0.0-alpha.
|
|
67
|
-
"@algolia/requester-browser-xhr": "5.0.0-alpha.
|
|
68
|
-
"@algolia/requester-node-http": "5.0.0-alpha.
|
|
62
|
+
"@algolia/client-abtesting": "5.0.0-alpha.54",
|
|
63
|
+
"@algolia/client-analytics": "5.0.0-alpha.54",
|
|
64
|
+
"@algolia/client-common": "5.0.0-alpha.54",
|
|
65
|
+
"@algolia/client-personalization": "5.0.0-alpha.54",
|
|
66
|
+
"@algolia/client-search": "5.0.0-alpha.54",
|
|
67
|
+
"@algolia/requester-browser-xhr": "5.0.0-alpha.54",
|
|
68
|
+
"@algolia/requester-node-http": "5.0.0-alpha.54"
|
|
69
69
|
},
|
|
70
70
|
"devDependencies": {
|
|
71
|
-
"@types/jest": "29.
|
|
72
|
-
"@types/node": "18.
|
|
73
|
-
"jest": "29.
|
|
71
|
+
"@types/jest": "29.5.0",
|
|
72
|
+
"@types/node": "18.15.3",
|
|
73
|
+
"jest": "29.5.0",
|
|
74
74
|
"rollup": "2.79.1",
|
|
75
75
|
"ts-jest": "29.0.5",
|
|
76
|
-
"typescript": "
|
|
76
|
+
"typescript": "5.0.2"
|
|
77
77
|
},
|
|
78
78
|
"engines": {
|
|
79
79
|
"node": ">= 14.0.0"
|