algoliasearch 5.1.0 → 5.2.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/README.md +2 -2
- package/builds/browser.ts +15 -48
- package/builds/models.ts +2 -2
- package/builds/node.ts +19 -58
- package/dist/algoliasearch/builds/browser.d.ts +13 -13
- package/dist/algoliasearch/builds/browser.d.ts.map +1 -1
- package/dist/algoliasearch/builds/models.d.ts +2 -2
- package/dist/algoliasearch/builds/models.d.ts.map +1 -1
- package/dist/algoliasearch/builds/node.d.ts +15 -15
- package/dist/algoliasearch/builds/node.d.ts.map +1 -1
- package/dist/algoliasearch.cjs +40 -70
- package/dist/algoliasearch.esm.browser.js +46 -75
- package/dist/algoliasearch.esm.node.js +40 -70
- package/dist/algoliasearch.umd.js +2 -2
- package/dist/client-abtesting/model/aBTest.d.ts +5 -5
- package/dist/client-abtesting/model/aBTest.d.ts.map +1 -1
- package/dist/client-abtesting/model/clientMethodProps.d.ts +2 -2
- package/dist/client-abtesting/model/clientMethodProps.d.ts.map +1 -1
- package/dist/client-abtesting/model/customSearchParams.d.ts +1 -1
- package/dist/client-abtesting/model/customSearchParams.d.ts.map +1 -1
- package/dist/client-abtesting/model/effect.d.ts.map +1 -1
- package/dist/client-abtesting/model/variant.d.ts +5 -5
- package/dist/client-abtesting/model/variant.d.ts.map +1 -1
- package/dist/client-abtesting/src/abtestingClient.d.ts +5 -5
- package/dist/client-abtesting/src/abtestingClient.d.ts.map +1 -1
- package/dist/client-analytics/model/clientMethodProps.d.ts +2 -2
- package/dist/client-analytics/model/clientMethodProps.d.ts.map +1 -1
- package/dist/client-analytics/model/{currenciesValue.d.ts → currencyCode.d.ts} +2 -2
- package/dist/client-analytics/model/currencyCode.d.ts.map +1 -0
- package/dist/client-analytics/model/dailyRevenue.d.ts +2 -2
- package/dist/client-analytics/model/dailyRevenue.d.ts.map +1 -1
- package/dist/client-analytics/model/getRevenue.d.ts +2 -2
- package/dist/client-analytics/model/getRevenue.d.ts.map +1 -1
- package/dist/client-analytics/model/getTopHitsResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/index.d.ts +1 -1
- package/dist/client-analytics/model/index.d.ts.map +1 -1
- package/dist/client-analytics/model/orderBy.d.ts.map +1 -1
- package/dist/client-analytics/model/topHitWithRevenueAnalytics.d.ts +2 -2
- package/dist/client-analytics/model/topHitWithRevenueAnalytics.d.ts.map +1 -1
- package/dist/client-analytics/model/topSearchWithRevenueAnalytics.d.ts +2 -2
- package/dist/client-analytics/model/topSearchWithRevenueAnalytics.d.ts.map +1 -1
- package/dist/client-analytics/src/analyticsClient.d.ts +11 -11
- 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/clientMethodProps.d.ts.map +1 -1
- package/dist/client-personalization/model/getUserTokenResponse.d.ts +1 -1
- package/dist/client-personalization/model/getUserTokenResponse.d.ts.map +1 -1
- package/dist/client-personalization/src/personalizationClient.d.ts +5 -5
- package/dist/client-personalization/src/personalizationClient.d.ts.map +1 -1
- package/dist/client-search/model/alternativesAsExact.d.ts.map +1 -1
- package/dist/client-search/model/baseIndexSettings.d.ts +2 -2
- package/dist/client-search/model/baseIndexSettings.d.ts.map +1 -1
- package/dist/client-search/model/baseSearchResponse.d.ts +4 -4
- package/dist/client-search/model/baseSearchResponse.d.ts.map +1 -1
- package/dist/client-search/model/batchRequest.d.ts +1 -1
- package/dist/client-search/model/batchRequest.d.ts.map +1 -1
- package/dist/client-search/model/browseResponse.d.ts.map +1 -1
- package/dist/client-search/model/clientMethodProps.d.ts +5 -6
- package/dist/client-search/model/clientMethodProps.d.ts.map +1 -1
- package/dist/client-search/model/consequenceParams.d.ts.map +1 -1
- package/dist/{lite/model/facetsStats.d.ts → client-search/model/facetStats.d.ts} +2 -2
- package/dist/client-search/model/facetStats.d.ts.map +1 -0
- package/dist/client-search/model/index.d.ts +1 -1
- package/dist/client-search/model/index.d.ts.map +1 -1
- package/dist/client-search/model/multipleBatchRequest.d.ts +1 -1
- package/dist/client-search/model/multipleBatchRequest.d.ts.map +1 -1
- package/dist/client-search/model/removeWordsIfNoResults.d.ts.map +1 -1
- package/dist/client-search/model/searchResponse.d.ts.map +1 -1
- package/dist/client-search/model/searchResult.d.ts.map +1 -1
- package/dist/client-search/model/synonymType.d.ts.map +1 -1
- package/dist/client-search/src/searchClient.d.ts +16 -16
- package/dist/client-search/src/searchClient.d.ts.map +1 -1
- package/dist/lite/builds/browser.d.ts +1 -1
- package/dist/lite/builds/browser.d.ts.map +1 -1
- package/dist/lite/builds/node.d.ts +1 -1
- package/dist/lite/builds/node.d.ts.map +1 -1
- package/dist/lite/lite.cjs +2 -5
- package/dist/lite/lite.esm.browser.js +11 -15
- package/dist/lite/lite.esm.node.js +2 -5
- package/dist/lite/lite.umd.js +2 -2
- package/dist/lite/model/alternativesAsExact.d.ts.map +1 -1
- package/dist/lite/model/baseIndexSettings.d.ts +2 -2
- package/dist/lite/model/baseIndexSettings.d.ts.map +1 -1
- package/dist/lite/model/baseSearchResponse.d.ts +4 -4
- package/dist/lite/model/baseSearchResponse.d.ts.map +1 -1
- package/dist/lite/model/boughtTogetherQuery.d.ts.map +1 -1
- package/dist/lite/model/browseResponse.d.ts.map +1 -1
- package/dist/lite/model/clientMethodProps.d.ts +1 -1
- package/dist/lite/model/clientMethodProps.d.ts.map +1 -1
- package/dist/lite/model/consequenceParams.d.ts.map +1 -1
- package/dist/{client-search/model/facetsStats.d.ts → lite/model/facetStats.d.ts} +2 -2
- package/dist/lite/model/facetStats.d.ts.map +1 -0
- package/dist/lite/model/fallbackParams.d.ts +1 -1
- package/dist/lite/model/fallbackParams.d.ts.map +1 -1
- package/dist/lite/model/index.d.ts +1 -1
- package/dist/lite/model/index.d.ts.map +1 -1
- package/dist/lite/model/recommendationsResults.d.ts.map +1 -1
- package/dist/lite/model/removeWordsIfNoResults.d.ts.map +1 -1
- package/dist/lite/model/searchParams.d.ts +1 -1
- package/dist/lite/model/searchParams.d.ts.map +1 -1
- package/dist/lite/model/searchResponse.d.ts.map +1 -1
- package/dist/lite/model/searchResult.d.ts.map +1 -1
- package/dist/lite/src/liteClient.d.ts +2 -2
- package/dist/lite/src/liteClient.d.ts.map +1 -1
- package/dist/recommend/model/alternativesAsExact.d.ts.map +1 -1
- package/dist/recommend/model/baseSearchResponse.d.ts +4 -4
- package/dist/recommend/model/baseSearchResponse.d.ts.map +1 -1
- package/dist/recommend/model/boughtTogetherQuery.d.ts.map +1 -1
- package/dist/recommend/model/clientMethodProps.d.ts +2 -2
- package/dist/recommend/model/clientMethodProps.d.ts.map +1 -1
- package/dist/recommend/model/{facetsStats.d.ts → facetStats.d.ts} +2 -2
- package/dist/recommend/model/facetStats.d.ts.map +1 -0
- package/dist/recommend/model/fallbackParams.d.ts +1 -1
- package/dist/recommend/model/fallbackParams.d.ts.map +1 -1
- package/dist/recommend/model/index.d.ts +1 -1
- package/dist/recommend/model/index.d.ts.map +1 -1
- package/dist/recommend/model/recommendModels.d.ts.map +1 -1
- package/dist/recommend/model/recommendationsResults.d.ts.map +1 -1
- package/dist/recommend/model/removeWordsIfNoResults.d.ts.map +1 -1
- package/dist/recommend/model/searchParams.d.ts +1 -1
- package/dist/recommend/model/searchParams.d.ts.map +1 -1
- package/dist/recommend/src/recommendClient.d.ts +6 -6
- package/dist/recommend/src/recommendClient.d.ts.map +1 -1
- package/lite/builds/browser.ts +2 -9
- package/lite/builds/node.ts +1 -5
- package/lite/model/alternativesAsExact.ts +1 -4
- package/lite/model/baseIndexSettings.ts +2 -2
- package/lite/model/baseSearchResponse.ts +4 -4
- package/lite/model/boughtTogetherQuery.ts +1 -2
- package/lite/model/browseResponse.ts +1 -4
- package/lite/model/clientMethodProps.ts +1 -1
- package/lite/model/consequenceParams.ts +1 -3
- package/lite/model/{facetsStats.ts → facetStats.ts} +1 -1
- package/lite/model/fallbackParams.ts +1 -1
- package/lite/model/index.ts +1 -1
- package/lite/model/recommendationsResults.ts +1 -3
- package/lite/model/removeWordsIfNoResults.ts +1 -5
- package/lite/model/searchParams.ts +1 -1
- package/lite/model/searchResponse.ts +1 -3
- package/lite/model/searchResult.ts +1 -3
- package/lite/src/liteClient.ts +17 -40
- package/package.json +20 -16
- package/dist/client-analytics/model/currenciesValue.d.ts.map +0 -1
- package/dist/client-search/model/facetsStats.d.ts.map +0 -1
- package/dist/lite/model/facetsStats.d.ts.map +0 -1
- package/dist/recommend/model/facetsStats.d.ts.map +0 -1
package/README.md
CHANGED
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
</p>
|
|
15
15
|
|
|
16
16
|
<p align="center">
|
|
17
|
-
<a href="https://www.algolia.com/doc/
|
|
17
|
+
<a href="https://www.algolia.com/doc/libraries/javascript/" target="_blank">Documentation</a> •
|
|
18
18
|
<a href="https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/" target="_blank">InstantSearch</a> •
|
|
19
19
|
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
|
|
20
20
|
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
|
|
@@ -63,7 +63,7 @@ import { liteClient } from 'algoliasearch/lite';
|
|
|
63
63
|
const client = liteClient('YOUR_APP_ID', 'YOUR_API_KEY');
|
|
64
64
|
```
|
|
65
65
|
|
|
66
|
-
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/
|
|
66
|
+
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.
|
|
67
67
|
|
|
68
68
|
## ❓ Troubleshooting
|
|
69
69
|
|
package/builds/browser.ts
CHANGED
|
@@ -2,15 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
import type { AbtestingClient } from '@algolia/client-abtesting';
|
|
4
4
|
import type { Region as AbtestingRegion } from '@algolia/client-abtesting/src/abtestingClient';
|
|
5
|
-
import {
|
|
6
|
-
createAbtestingClient,
|
|
7
|
-
REGIONS as abtestingRegions,
|
|
8
|
-
} from '@algolia/client-abtesting/src/abtestingClient';
|
|
5
|
+
import { createAbtestingClient, REGIONS as abtestingRegions } from '@algolia/client-abtesting/src/abtestingClient';
|
|
9
6
|
import type { AnalyticsClient } from '@algolia/client-analytics';
|
|
10
|
-
import {
|
|
11
|
-
createAnalyticsClient,
|
|
12
|
-
REGIONS as analyticsRegions,
|
|
13
|
-
} from '@algolia/client-analytics/src/analyticsClient';
|
|
7
|
+
import { createAnalyticsClient, REGIONS as analyticsRegions } from '@algolia/client-analytics/src/analyticsClient';
|
|
14
8
|
import type { Region as AnalyticsRegion } from '@algolia/client-analytics/src/analyticsClient';
|
|
15
9
|
import {
|
|
16
10
|
DEFAULT_CONNECT_TIMEOUT_BROWSER,
|
|
@@ -20,20 +14,14 @@ import {
|
|
|
20
14
|
createFallbackableCache,
|
|
21
15
|
createMemoryCache,
|
|
22
16
|
} from '@algolia/client-common';
|
|
23
|
-
import type {
|
|
24
|
-
ClientOptions,
|
|
25
|
-
CreateClientOptions,
|
|
26
|
-
} from '@algolia/client-common';
|
|
17
|
+
import type { ClientOptions, CreateClientOptions } from '@algolia/client-common';
|
|
27
18
|
import type { PersonalizationClient } from '@algolia/client-personalization';
|
|
28
19
|
import type { Region as PersonalizationRegion } from '@algolia/client-personalization/src/personalizationClient';
|
|
29
20
|
import {
|
|
30
21
|
createPersonalizationClient,
|
|
31
22
|
REGIONS as personalizationRegions,
|
|
32
23
|
} from '@algolia/client-personalization/src/personalizationClient';
|
|
33
|
-
import {
|
|
34
|
-
createSearchClient,
|
|
35
|
-
apiClientVersion as searchClientVersion,
|
|
36
|
-
} from '@algolia/client-search/src/searchClient';
|
|
24
|
+
import { createSearchClient, apiClientVersion as searchClientVersion } from '@algolia/client-search/src/searchClient';
|
|
37
25
|
import type { RecommendClient } from '@algolia/recommend';
|
|
38
26
|
import { createRecommendClient } from '@algolia/recommend/src/recommendClient';
|
|
39
27
|
import { createXhrRequester } from '@algolia/requester-browser-xhr';
|
|
@@ -50,11 +38,7 @@ export const apiClientVersion = searchClientVersion;
|
|
|
50
38
|
export type Algoliasearch = ReturnType<typeof algoliasearch>;
|
|
51
39
|
|
|
52
40
|
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
53
|
-
export function algoliasearch(
|
|
54
|
-
appId: string,
|
|
55
|
-
apiKey: string,
|
|
56
|
-
options?: ClientOptions
|
|
57
|
-
) {
|
|
41
|
+
export function algoliasearch(appId: string, apiKey: string, options?: ClientOptions) {
|
|
58
42
|
if (!appId || typeof appId !== 'string') {
|
|
59
43
|
throw new Error('`appId` is missing.');
|
|
60
44
|
}
|
|
@@ -76,10 +60,7 @@ export function algoliasearch(
|
|
|
76
60
|
responsesCache: createMemoryCache(),
|
|
77
61
|
requestsCache: createMemoryCache({ serializable: false }),
|
|
78
62
|
hostsCache: createFallbackableCache({
|
|
79
|
-
caches: [
|
|
80
|
-
createBrowserLocalStorageCache({ key: `${apiClientVersion}-${appId}` }),
|
|
81
|
-
createMemoryCache(),
|
|
82
|
-
],
|
|
63
|
+
caches: [createBrowserLocalStorageCache({ key: `${apiClientVersion}-${appId}` }), createMemoryCache()],
|
|
83
64
|
}),
|
|
84
65
|
...options,
|
|
85
66
|
};
|
|
@@ -92,17 +73,12 @@ export function algoliasearch(
|
|
|
92
73
|
});
|
|
93
74
|
}
|
|
94
75
|
|
|
95
|
-
function initAnalytics(
|
|
96
|
-
initOptions: InitClientOptions & InitClientRegion<AnalyticsRegion> = {}
|
|
97
|
-
): AnalyticsClient {
|
|
76
|
+
function initAnalytics(initOptions: InitClientOptions & InitClientRegion<AnalyticsRegion> = {}): AnalyticsClient {
|
|
98
77
|
if (
|
|
99
78
|
initOptions.region &&
|
|
100
|
-
(typeof initOptions.region !== 'string' ||
|
|
101
|
-
!analyticsRegions.includes(initOptions.region))
|
|
79
|
+
(typeof initOptions.region !== 'string' || !analyticsRegions.includes(initOptions.region))
|
|
102
80
|
) {
|
|
103
|
-
throw new Error(
|
|
104
|
-
`\`region\` must be one of the following: ${analyticsRegions.join(', ')}`
|
|
105
|
-
);
|
|
81
|
+
throw new Error(`\`region\` must be one of the following: ${analyticsRegions.join(', ')}`);
|
|
106
82
|
}
|
|
107
83
|
|
|
108
84
|
return createAnalyticsClient({
|
|
@@ -112,17 +88,12 @@ export function algoliasearch(
|
|
|
112
88
|
});
|
|
113
89
|
}
|
|
114
90
|
|
|
115
|
-
function initAbtesting(
|
|
116
|
-
initOptions: InitClientOptions & InitClientRegion<AbtestingRegion> = {}
|
|
117
|
-
): AbtestingClient {
|
|
91
|
+
function initAbtesting(initOptions: InitClientOptions & InitClientRegion<AbtestingRegion> = {}): AbtestingClient {
|
|
118
92
|
if (
|
|
119
93
|
initOptions.region &&
|
|
120
|
-
(typeof initOptions.region !== 'string' ||
|
|
121
|
-
!abtestingRegions.includes(initOptions.region))
|
|
94
|
+
(typeof initOptions.region !== 'string' || !abtestingRegions.includes(initOptions.region))
|
|
122
95
|
) {
|
|
123
|
-
throw new Error(
|
|
124
|
-
`\`region\` must be one of the following: ${abtestingRegions.join(', ')}`
|
|
125
|
-
);
|
|
96
|
+
throw new Error(`\`region\` must be one of the following: ${abtestingRegions.join(', ')}`);
|
|
126
97
|
}
|
|
127
98
|
|
|
128
99
|
return createAbtestingClient({
|
|
@@ -133,18 +104,14 @@ export function algoliasearch(
|
|
|
133
104
|
}
|
|
134
105
|
|
|
135
106
|
function initPersonalization(
|
|
136
|
-
initOptions: InitClientOptions &
|
|
137
|
-
Required<InitClientRegion<PersonalizationRegion>>
|
|
107
|
+
initOptions: InitClientOptions & Required<InitClientRegion<PersonalizationRegion>>,
|
|
138
108
|
): PersonalizationClient {
|
|
139
109
|
if (
|
|
140
110
|
!initOptions.region ||
|
|
141
111
|
(initOptions.region &&
|
|
142
|
-
(typeof initOptions.region !== 'string' ||
|
|
143
|
-
!personalizationRegions.includes(initOptions.region)))
|
|
112
|
+
(typeof initOptions.region !== 'string' || !personalizationRegions.includes(initOptions.region)))
|
|
144
113
|
) {
|
|
145
|
-
throw new Error(
|
|
146
|
-
`\`region\` is required and must be one of the following: ${personalizationRegions.join(', ')}`
|
|
147
|
-
);
|
|
114
|
+
throw new Error(`\`region\` is required and must be one of the following: ${personalizationRegions.join(', ')}`);
|
|
148
115
|
}
|
|
149
116
|
|
|
150
117
|
return createPersonalizationClient({
|
package/builds/models.ts
CHANGED
|
@@ -33,7 +33,7 @@ import {
|
|
|
33
33
|
FacetFilters,
|
|
34
34
|
FacetOrdering,
|
|
35
35
|
Facets,
|
|
36
|
-
|
|
36
|
+
FacetStats,
|
|
37
37
|
HighlightResult,
|
|
38
38
|
HighlightResultOption,
|
|
39
39
|
IgnorePlurals,
|
|
@@ -119,7 +119,7 @@ export {
|
|
|
119
119
|
FacetFilters,
|
|
120
120
|
FacetOrdering,
|
|
121
121
|
Facets,
|
|
122
|
-
|
|
122
|
+
FacetStats,
|
|
123
123
|
HighlightResult,
|
|
124
124
|
HighlightResultOption,
|
|
125
125
|
IgnorePlurals,
|
package/builds/node.ts
CHANGED
|
@@ -4,15 +4,9 @@ import { createHmac } from 'crypto';
|
|
|
4
4
|
|
|
5
5
|
import type { AbtestingClient } from '@algolia/client-abtesting';
|
|
6
6
|
import type { Region as AbtestingRegion } from '@algolia/client-abtesting/src/abtestingClient';
|
|
7
|
-
import {
|
|
8
|
-
createAbtestingClient,
|
|
9
|
-
REGIONS as abtestingRegions,
|
|
10
|
-
} from '@algolia/client-abtesting/src/abtestingClient';
|
|
7
|
+
import { createAbtestingClient, REGIONS as abtestingRegions } from '@algolia/client-abtesting/src/abtestingClient';
|
|
11
8
|
import type { AnalyticsClient } from '@algolia/client-analytics';
|
|
12
|
-
import {
|
|
13
|
-
createAnalyticsClient,
|
|
14
|
-
REGIONS as analyticsRegions,
|
|
15
|
-
} from '@algolia/client-analytics/src/analyticsClient';
|
|
9
|
+
import { createAnalyticsClient, REGIONS as analyticsRegions } from '@algolia/client-analytics/src/analyticsClient';
|
|
16
10
|
import type { Region as AnalyticsRegion } from '@algolia/client-analytics/src/analyticsClient';
|
|
17
11
|
import {
|
|
18
12
|
DEFAULT_CONNECT_TIMEOUT_NODE,
|
|
@@ -22,20 +16,14 @@ import {
|
|
|
22
16
|
createNullCache,
|
|
23
17
|
serializeQueryParameters,
|
|
24
18
|
} from '@algolia/client-common';
|
|
25
|
-
import type {
|
|
26
|
-
ClientOptions,
|
|
27
|
-
CreateClientOptions,
|
|
28
|
-
} from '@algolia/client-common';
|
|
19
|
+
import type { ClientOptions, CreateClientOptions } from '@algolia/client-common';
|
|
29
20
|
import type { PersonalizationClient } from '@algolia/client-personalization';
|
|
30
21
|
import type { Region as PersonalizationRegion } from '@algolia/client-personalization/src/personalizationClient';
|
|
31
22
|
import {
|
|
32
23
|
createPersonalizationClient,
|
|
33
24
|
REGIONS as personalizationRegions,
|
|
34
25
|
} from '@algolia/client-personalization/src/personalizationClient';
|
|
35
|
-
import {
|
|
36
|
-
createSearchClient,
|
|
37
|
-
apiClientVersion as searchClientVersion,
|
|
38
|
-
} from '@algolia/client-search/src/searchClient';
|
|
26
|
+
import { createSearchClient, apiClientVersion as searchClientVersion } from '@algolia/client-search/src/searchClient';
|
|
39
27
|
import type { RecommendClient } from '@algolia/recommend';
|
|
40
28
|
import { createRecommendClient } from '@algolia/recommend/src/recommendClient';
|
|
41
29
|
import { createHttpRequester } from '@algolia/requester-node-http';
|
|
@@ -57,11 +45,7 @@ export const apiClientVersion = searchClientVersion;
|
|
|
57
45
|
export type Algoliasearch = ReturnType<typeof algoliasearch>;
|
|
58
46
|
|
|
59
47
|
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
60
|
-
export function algoliasearch(
|
|
61
|
-
appId: string,
|
|
62
|
-
apiKey: string,
|
|
63
|
-
options?: ClientOptions
|
|
64
|
-
) {
|
|
48
|
+
export function algoliasearch(appId: string, apiKey: string, options?: ClientOptions) {
|
|
65
49
|
if (!appId || typeof appId !== 'string') {
|
|
66
50
|
throw new Error('`appId` is missing.');
|
|
67
51
|
}
|
|
@@ -93,17 +77,12 @@ export function algoliasearch(
|
|
|
93
77
|
});
|
|
94
78
|
}
|
|
95
79
|
|
|
96
|
-
function initAnalytics(
|
|
97
|
-
initOptions: InitClientOptions & InitClientRegion<AnalyticsRegion> = {}
|
|
98
|
-
): AnalyticsClient {
|
|
80
|
+
function initAnalytics(initOptions: InitClientOptions & InitClientRegion<AnalyticsRegion> = {}): AnalyticsClient {
|
|
99
81
|
if (
|
|
100
82
|
initOptions.region &&
|
|
101
|
-
(typeof initOptions.region !== 'string' ||
|
|
102
|
-
!analyticsRegions.includes(initOptions.region))
|
|
83
|
+
(typeof initOptions.region !== 'string' || !analyticsRegions.includes(initOptions.region))
|
|
103
84
|
) {
|
|
104
|
-
throw new Error(
|
|
105
|
-
`\`region\` must be one of the following: ${analyticsRegions.join(', ')}`
|
|
106
|
-
);
|
|
85
|
+
throw new Error(`\`region\` must be one of the following: ${analyticsRegions.join(', ')}`);
|
|
107
86
|
}
|
|
108
87
|
|
|
109
88
|
return createAnalyticsClient({
|
|
@@ -113,17 +92,12 @@ export function algoliasearch(
|
|
|
113
92
|
});
|
|
114
93
|
}
|
|
115
94
|
|
|
116
|
-
function initAbtesting(
|
|
117
|
-
initOptions: InitClientOptions & InitClientRegion<AbtestingRegion> = {}
|
|
118
|
-
): AbtestingClient {
|
|
95
|
+
function initAbtesting(initOptions: InitClientOptions & InitClientRegion<AbtestingRegion> = {}): AbtestingClient {
|
|
119
96
|
if (
|
|
120
97
|
initOptions.region &&
|
|
121
|
-
(typeof initOptions.region !== 'string' ||
|
|
122
|
-
!abtestingRegions.includes(initOptions.region))
|
|
98
|
+
(typeof initOptions.region !== 'string' || !abtestingRegions.includes(initOptions.region))
|
|
123
99
|
) {
|
|
124
|
-
throw new Error(
|
|
125
|
-
`\`region\` must be one of the following: ${abtestingRegions.join(', ')}`
|
|
126
|
-
);
|
|
100
|
+
throw new Error(`\`region\` must be one of the following: ${abtestingRegions.join(', ')}`);
|
|
127
101
|
}
|
|
128
102
|
|
|
129
103
|
return createAbtestingClient({
|
|
@@ -134,18 +108,14 @@ export function algoliasearch(
|
|
|
134
108
|
}
|
|
135
109
|
|
|
136
110
|
function initPersonalization(
|
|
137
|
-
initOptions: InitClientOptions &
|
|
138
|
-
Required<InitClientRegion<PersonalizationRegion>>
|
|
111
|
+
initOptions: InitClientOptions & Required<InitClientRegion<PersonalizationRegion>>,
|
|
139
112
|
): PersonalizationClient {
|
|
140
113
|
if (
|
|
141
114
|
!initOptions.region ||
|
|
142
115
|
(initOptions.region &&
|
|
143
|
-
(typeof initOptions.region !== 'string' ||
|
|
144
|
-
!personalizationRegions.includes(initOptions.region)))
|
|
116
|
+
(typeof initOptions.region !== 'string' || !personalizationRegions.includes(initOptions.region)))
|
|
145
117
|
) {
|
|
146
|
-
throw new Error(
|
|
147
|
-
`\`region\` is required and must be one of the following: ${personalizationRegions.join(', ')}`
|
|
148
|
-
);
|
|
118
|
+
throw new Error(`\`region\` is required and must be one of the following: ${personalizationRegions.join(', ')}`);
|
|
149
119
|
}
|
|
150
120
|
|
|
151
121
|
return createPersonalizationClient({
|
|
@@ -175,10 +145,7 @@ export function algoliasearch(
|
|
|
175
145
|
* @param generateSecuredApiKey.parentApiKey - The base API key from which to generate the new secured one.
|
|
176
146
|
* @param generateSecuredApiKey.restrictions - A set of properties defining the restrictions of the secured API key.
|
|
177
147
|
*/
|
|
178
|
-
generateSecuredApiKey({
|
|
179
|
-
parentApiKey,
|
|
180
|
-
restrictions = {},
|
|
181
|
-
}: GenerateSecuredApiKeyOptions): string {
|
|
148
|
+
generateSecuredApiKey({ parentApiKey, restrictions = {} }: GenerateSecuredApiKeyOptions): string {
|
|
182
149
|
let mergedRestrictions = restrictions;
|
|
183
150
|
if (restrictions.searchParams) {
|
|
184
151
|
// merge searchParams with the root restrictions
|
|
@@ -198,14 +165,12 @@ export function algoliasearch(
|
|
|
198
165
|
acc[key] = (mergedRestrictions as any)[key];
|
|
199
166
|
return acc;
|
|
200
167
|
},
|
|
201
|
-
{} as Record<string, unknown
|
|
168
|
+
{} as Record<string, unknown>,
|
|
202
169
|
);
|
|
203
170
|
|
|
204
171
|
const queryParameters = serializeQueryParameters(mergedRestrictions);
|
|
205
172
|
return Buffer.from(
|
|
206
|
-
createHmac('sha256', parentApiKey)
|
|
207
|
-
.update(queryParameters)
|
|
208
|
-
.digest('hex') + queryParameters
|
|
173
|
+
createHmac('sha256', parentApiKey).update(queryParameters).digest('hex') + queryParameters,
|
|
209
174
|
).toString('base64');
|
|
210
175
|
},
|
|
211
176
|
|
|
@@ -216,12 +181,8 @@ export function algoliasearch(
|
|
|
216
181
|
* @param getSecuredApiKeyRemainingValidity - The `getSecuredApiKeyRemainingValidity` object.
|
|
217
182
|
* @param getSecuredApiKeyRemainingValidity.securedApiKey - The secured API key generated with the `generateSecuredApiKey` method.
|
|
218
183
|
*/
|
|
219
|
-
getSecuredApiKeyRemainingValidity({
|
|
220
|
-
securedApiKey,
|
|
221
|
-
}: GetSecuredApiKeyRemainingValidityOptions): number {
|
|
222
|
-
const decodedString = Buffer.from(securedApiKey, 'base64').toString(
|
|
223
|
-
'ascii'
|
|
224
|
-
);
|
|
184
|
+
getSecuredApiKeyRemainingValidity({ securedApiKey }: GetSecuredApiKeyRemainingValidityOptions): number {
|
|
185
|
+
const decodedString = Buffer.from(securedApiKey, 'base64').toString('ascii');
|
|
225
186
|
const regex = /validUntil=(\d+)/;
|
|
226
187
|
const match = decodedString.match(regex);
|
|
227
188
|
|
|
@@ -8,7 +8,7 @@ import type { Region as PersonalizationRegion } from '@algolia/client-personaliz
|
|
|
8
8
|
import type { RecommendClient } from '@algolia/recommend';
|
|
9
9
|
import type { InitClientOptions, InitClientRegion } from './models';
|
|
10
10
|
export * from './models';
|
|
11
|
-
export declare const apiClientVersion = "5.1
|
|
11
|
+
export declare const apiClientVersion = "5.2.1";
|
|
12
12
|
/**
|
|
13
13
|
* The client type.
|
|
14
14
|
*/
|
|
@@ -29,7 +29,7 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
|
|
|
29
29
|
browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: import("@algolia/client-search/model/clientMethodProps").BrowseOptions<import("@algolia/client-search/model/browseResponse").BrowseResponse<T>> & import("@algolia/client-search/model/clientMethodProps").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/browseResponse").BrowseResponse<T>>;
|
|
30
30
|
browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: import("@algolia/client-search/model/clientMethodProps").BrowseOptions<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse> & import("@algolia/client-search/model/clientMethodProps").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse>;
|
|
31
31
|
browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }: import("@algolia/client-search/model/clientMethodProps").BrowseOptions<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse> & import("@algolia/client-search/model/clientMethodProps").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>;
|
|
32
|
-
chunkedBatch({ indexName, objects, action, waitForTasks, batchSize
|
|
32
|
+
chunkedBatch({ indexName, objects, action, waitForTasks, batchSize }: import("@algolia/client-search/model/clientMethodProps").ChunkedBatchOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
|
|
33
33
|
saveObjects({ indexName, objects }: import("@algolia/client-search/model/clientMethodProps").SaveObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
|
|
34
34
|
deleteObjects({ indexName, objectIDs }: import("@algolia/client-search/model/clientMethodProps").DeleteObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
|
|
35
35
|
partialUpdateObjects({ indexName, objects, createIfNotExists }: import("@algolia/client-search/model/clientMethodProps").PartialUpdateObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
|
|
@@ -46,15 +46,15 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
|
|
|
46
46
|
assignUserId({ xAlgoliaUserID, assignUserIdParams }: import("@algolia/client-search/model/clientMethodProps").AssignUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/createdAtResponse").CreatedAtResponse>;
|
|
47
47
|
batch({ indexName, batchWriteParams }: import("@algolia/client-search/model/clientMethodProps").BatchProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse>;
|
|
48
48
|
batchAssignUserIds({ xAlgoliaUserID, batchAssignUserIdsParams }: import("@algolia/client-search/model/clientMethodProps").BatchAssignUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/createdAtResponse").CreatedAtResponse>;
|
|
49
|
-
batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams
|
|
49
|
+
batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams }: import("@algolia/client-search/model/clientMethodProps").BatchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
50
50
|
browse<T>({ indexName, browseParams }: import("@algolia/client-search/model/clientMethodProps").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/browseResponse").BrowseResponse<T>>;
|
|
51
51
|
clearObjects({ indexName }: import("@algolia/client-search/model/clientMethodProps").ClearObjectsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
52
52
|
clearRules({ indexName, forwardToReplicas }: import("@algolia/client-search/model/clientMethodProps").ClearRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
53
53
|
clearSynonyms({ indexName, forwardToReplicas }: import("@algolia/client-search/model/clientMethodProps").ClearSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
54
|
-
customDelete({ path, parameters }: import("@algolia/client-search/model/clientMethodProps").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string,
|
|
55
|
-
customGet({ path, parameters }: import("@algolia/client-search/model/clientMethodProps").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string,
|
|
56
|
-
customPost({ path, parameters, body }: import("@algolia/client-search/model/clientMethodProps").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string,
|
|
57
|
-
customPut({ path, parameters, body }: import("@algolia/client-search/model/clientMethodProps").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string,
|
|
54
|
+
customDelete({ path, parameters }: import("@algolia/client-search/model/clientMethodProps").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, unknown>>;
|
|
55
|
+
customGet({ path, parameters }: import("@algolia/client-search/model/clientMethodProps").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, unknown>>;
|
|
56
|
+
customPost({ path, parameters, body }: import("@algolia/client-search/model/clientMethodProps").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, unknown>>;
|
|
57
|
+
customPut({ path, parameters, body }: import("@algolia/client-search/model/clientMethodProps").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, unknown>>;
|
|
58
58
|
deleteApiKey({ key }: import("@algolia/client-search/model/clientMethodProps").DeleteApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/deleteApiKeyResponse").DeleteApiKeyResponse>;
|
|
59
59
|
deleteBy({ indexName, deleteByParams }: import("@algolia/client-search/model/clientMethodProps").DeleteByProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/deletedAtResponse").DeletedAtResponse>;
|
|
60
60
|
deleteIndex({ indexName }: import("@algolia/client-search/model/clientMethodProps").DeleteIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/deletedAtResponse").DeletedAtResponse>;
|
|
@@ -67,7 +67,7 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
|
|
|
67
67
|
getDictionaryLanguages(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, import("@algolia/client-search/model/languages").Languages>>;
|
|
68
68
|
getDictionarySettings(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/getDictionarySettingsResponse").GetDictionarySettingsResponse>;
|
|
69
69
|
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>;
|
|
70
|
-
getObject({ indexName, objectID, attributesToRetrieve }: import("@algolia/client-search/model/clientMethodProps").GetObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string,
|
|
70
|
+
getObject({ indexName, objectID, attributesToRetrieve }: import("@algolia/client-search/model/clientMethodProps").GetObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, unknown>>;
|
|
71
71
|
getObjects<T>(getObjectsParams: import("@algolia/client-search/model/getObjectsParams").GetObjectsParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/getObjectsResponse").GetObjectsResponse<T>>;
|
|
72
72
|
getRule({ indexName, objectID }: import("@algolia/client-search/model/clientMethodProps").GetRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/rule").Rule>;
|
|
73
73
|
getSettings({ indexName }: import("@algolia/client-search/model/clientMethodProps").GetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/settingsResponse").SettingsResponse>;
|
|
@@ -83,18 +83,18 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
|
|
|
83
83
|
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>;
|
|
84
84
|
multipleBatch(batchParams: import("@algolia/client-search/model/batchParams").BatchParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/multipleBatchResponse").MultipleBatchResponse>;
|
|
85
85
|
operationIndex({ indexName, operationIndexParams }: import("@algolia/client-search/model/clientMethodProps").OperationIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
86
|
-
partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists
|
|
86
|
+
partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists }: import("@algolia/client-search/model/clientMethodProps").PartialUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/updatedAtWithObjectIdResponse").UpdatedAtWithObjectIdResponse>;
|
|
87
87
|
removeUserId({ userID }: import("@algolia/client-search/model/clientMethodProps").RemoveUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/removeUserIdResponse").RemoveUserIdResponse>;
|
|
88
88
|
replaceSources({ source }: import("@algolia/client-search/model/clientMethodProps").ReplaceSourcesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/replaceSourceResponse").ReplaceSourceResponse>;
|
|
89
89
|
restoreApiKey({ key }: import("@algolia/client-search/model/clientMethodProps").RestoreApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/addApiKeyResponse").AddApiKeyResponse>;
|
|
90
90
|
saveObject({ indexName, body }: import("@algolia/client-search/model/clientMethodProps").SaveObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/saveObjectResponse").SaveObjectResponse>;
|
|
91
91
|
saveRule({ indexName, objectID, rule, forwardToReplicas }: import("@algolia/client-search/model/clientMethodProps").SaveRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/updatedRuleResponse").UpdatedRuleResponse>;
|
|
92
|
-
saveRules({ indexName, rules, forwardToReplicas, clearExistingRules
|
|
92
|
+
saveRules({ indexName, rules, forwardToReplicas, clearExistingRules }: import("@algolia/client-search/model/clientMethodProps").SaveRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
93
93
|
saveSynonym({ indexName, objectID, synonymHit, forwardToReplicas }: import("@algolia/client-search/model/clientMethodProps").SaveSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/saveSynonymResponse").SaveSynonymResponse>;
|
|
94
|
-
saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms
|
|
94
|
+
saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms }: import("@algolia/client-search/model/clientMethodProps").SaveSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
95
95
|
search<T>(searchMethodParams: import("@algolia/client-search/model/clientMethodProps").LegacySearchMethodProps | import("@algolia/client-search/model/searchMethodParams").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/searchResponses").SearchResponses<T>>;
|
|
96
|
-
searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams
|
|
97
|
-
searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest
|
|
96
|
+
searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams }: import("@algolia/client-search/model/clientMethodProps").SearchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/searchDictionaryEntriesResponse").SearchDictionaryEntriesResponse>;
|
|
97
|
+
searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest }: import("@algolia/client-search/model/clientMethodProps").SearchForFacetValuesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/searchForFacetValuesResponse").SearchForFacetValuesResponse>;
|
|
98
98
|
searchRules({ indexName, searchRulesParams }: import("@algolia/client-search/model/clientMethodProps").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse>;
|
|
99
99
|
searchSingleIndex<T>({ indexName, searchParams }: import("@algolia/client-search/model/clientMethodProps").SearchSingleIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/searchResponse").SearchResponse<T>>;
|
|
100
100
|
searchSynonyms({ indexName, searchSynonymsParams }: import("@algolia/client-search/model/clientMethodProps").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>;
|
|
@@ -1 +1 @@
|
|
|
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;
|
|
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;AAE/F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAEjE,OAAO,KAAK,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,+CAA+C,CAAC;AAS/F,OAAO,KAAK,EAAE,aAAa,EAAuB,MAAM,wBAAwB,CAAC;AACjF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,KAAK,EAAE,MAAM,IAAI,qBAAqB,EAAE,MAAM,2DAA2D,CAAC;AAMjH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAI1D,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAEpE,cAAc,UAAU,CAAC;AAEzB,eAAO,MAAM,gBAAgB,UAAsB,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC;AAG7D,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;;kCAkD9C,iBAAiB,GAAG,gBAAgB,CAAC,eAAe,CAAC,KAAQ,eAAe;kCAf5E,iBAAiB,GAAG,gBAAgB,CAAC,eAAe,CAAC,KAAQ,eAAe;uCA+BjG,iBAAiB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,CAAC,KACjF,qBAAqB;kCAxCY,iBAAiB,KAAQ,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAqE7E"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { ClientOptions } from '@algolia/client-common';
|
|
2
|
-
import { AdvancedSyntaxFeatures, AlternativesAsExact, Anchoring, AroundPrecision, AroundRadius, AroundRadiusAll, AutomaticFacetFilter, AutomaticFacetFilters, BaseSearchParams, BaseSearchParamsWithoutQuery, BaseSearchResponse, Condition, Consequence, ConsequenceHide, ConsequenceParams, ConsequenceQuery, ConsequenceQueryObject, CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, DeletedAtResponse, Distinct, Edit, EditType, ErrorBase, ExactOnSingleWordQuery, Exhaustive, FacetFilters, FacetOrdering, Facets,
|
|
2
|
+
import { AdvancedSyntaxFeatures, AlternativesAsExact, Anchoring, AroundPrecision, AroundRadius, AroundRadiusAll, AutomaticFacetFilter, AutomaticFacetFilters, BaseSearchParams, BaseSearchParamsWithoutQuery, BaseSearchResponse, Condition, Consequence, ConsequenceHide, ConsequenceParams, ConsequenceQuery, ConsequenceQueryObject, CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, DeletedAtResponse, Distinct, Edit, EditType, ErrorBase, ExactOnSingleWordQuery, Exhaustive, FacetFilters, FacetOrdering, Facets, FacetStats, HighlightResult, HighlightResultOption, IgnorePlurals, IndexSettingsAsSearchParams, MatchLevel, MatchedGeoLocation, Mode, NumericFilters, OptionalFilters, Params, Personalization, Promote, PromoteObjectID, PromoteObjectIDs, QueryType, Range, RankingInfo, ReRankingApplyFilter, Redirect, RedirectRuleIndexMetadata, RedirectRuleIndexData, RedirectURL, RemoveStopWords, RemoveWordsIfNoResults, RenderingContent, SearchPagination, SearchParams, SearchParamsObject, SearchParamsQuery, SemanticSearch, SnippetResult, SnippetResultOption, SortRemainingBy, SupportedLanguage, TagFilters, TaskStatus, TypoTolerance, TypoToleranceEnum, Value } from '@algolia/client-search/model';
|
|
3
3
|
export * from '@algolia/client-search/model';
|
|
4
4
|
export * from '@algolia/recommend/model';
|
|
5
5
|
export * from '@algolia/client-personalization/model';
|
|
@@ -10,7 +10,7 @@ export { RecommendClient } from '@algolia/recommend';
|
|
|
10
10
|
export { PersonalizationClient } from '@algolia/client-personalization';
|
|
11
11
|
export { AnalyticsClient } from '@algolia/client-analytics';
|
|
12
12
|
export { AbtestingClient } from '@algolia/client-abtesting';
|
|
13
|
-
export { AdvancedSyntaxFeatures, AlternativesAsExact, Anchoring, AroundPrecision, AroundRadius, AroundRadiusAll, AutomaticFacetFilter, AutomaticFacetFilters, BaseSearchParams, BaseSearchParamsWithoutQuery, BaseSearchResponse, Condition, Consequence, ConsequenceHide, ConsequenceParams, ConsequenceQuery, ConsequenceQueryObject, CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, DeletedAtResponse, Distinct, Edit, EditType, ErrorBase, ExactOnSingleWordQuery, Exhaustive, FacetFilters, FacetOrdering, Facets,
|
|
13
|
+
export { AdvancedSyntaxFeatures, AlternativesAsExact, Anchoring, AroundPrecision, AroundRadius, AroundRadiusAll, AutomaticFacetFilter, AutomaticFacetFilters, BaseSearchParams, BaseSearchParamsWithoutQuery, BaseSearchResponse, Condition, Consequence, ConsequenceHide, ConsequenceParams, ConsequenceQuery, ConsequenceQueryObject, CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, DeletedAtResponse, Distinct, Edit, EditType, ErrorBase, ExactOnSingleWordQuery, Exhaustive, FacetFilters, FacetOrdering, Facets, FacetStats, HighlightResult, HighlightResultOption, IgnorePlurals, IndexSettingsAsSearchParams, MatchLevel, MatchedGeoLocation, Mode, NumericFilters, OptionalFilters, Params, Personalization, Promote, PromoteObjectID, PromoteObjectIDs, QueryType, Range, RankingInfo, ReRankingApplyFilter, Redirect, RedirectRuleIndexMetadata, RedirectRuleIndexData, RedirectURL, RemoveStopWords, RemoveWordsIfNoResults, RenderingContent, SearchParams, SearchParamsObject, SearchParamsQuery, SemanticSearch, SearchPagination, SnippetResult, SnippetResultOption, SortRemainingBy, SupportedLanguage, TagFilters, TaskStatus, TypoTolerance, TypoToleranceEnum, Value, };
|
|
14
14
|
/**
|
|
15
15
|
* Options forwarded to the client initialized via the `init` method.
|
|
16
16
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../../builds/models.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EACL,sBAAsB,EACtB,mBAAmB,EACnB,SAAS,EACT,eAAe,EACf,YAAY,EACZ,eAAe,EACf,oBAAoB,EACpB,qBAAqB,EACrB,gBAAgB,EAChB,4BAA4B,EAC5B,kBAAkB,EAClB,SAAS,EACT,WAAW,EACX,eAAe,EACf,iBAAiB,EACjB,gBAAgB,EAChB,sBAAsB,EACtB,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,QAAQ,EACR,IAAI,EACJ,QAAQ,EACR,SAAS,EACT,sBAAsB,EACtB,UAAU,EACV,YAAY,EACZ,aAAa,EACb,MAAM,EACN,
|
|
1
|
+
{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../../builds/models.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EACL,sBAAsB,EACtB,mBAAmB,EACnB,SAAS,EACT,eAAe,EACf,YAAY,EACZ,eAAe,EACf,oBAAoB,EACpB,qBAAqB,EACrB,gBAAgB,EAChB,4BAA4B,EAC5B,kBAAkB,EAClB,SAAS,EACT,WAAW,EACX,eAAe,EACf,iBAAiB,EACjB,gBAAgB,EAChB,sBAAsB,EACtB,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,QAAQ,EACR,IAAI,EACJ,QAAQ,EACR,SAAS,EACT,sBAAsB,EACtB,UAAU,EACV,YAAY,EACZ,aAAa,EACb,MAAM,EACN,UAAU,EACV,eAAe,EACf,qBAAqB,EACrB,aAAa,EACb,2BAA2B,EAC3B,UAAU,EACV,kBAAkB,EAClB,IAAI,EACJ,cAAc,EACd,eAAe,EACf,MAAM,EACN,eAAe,EACf,OAAO,EACP,eAAe,EACf,gBAAgB,EAChB,SAAS,EACT,KAAK,EACL,WAAW,EACX,oBAAoB,EACpB,QAAQ,EACR,yBAAyB,EACzB,qBAAqB,EACrB,WAAW,EACX,eAAe,EACf,sBAAsB,EACtB,gBAAgB,EAChB,gBAAgB,EAChB,YAAY,EACZ,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,EACd,aAAa,EACb,mBAAmB,EACnB,eAAe,EACf,iBAAiB,EACjB,UAAU,EACV,UAAU,EACV,aAAa,EACb,iBAAiB,EACjB,KAAK,EACN,MAAM,8BAA8B,CAAC;AAEtC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AACzC,cAAc,uCAAuC,CAAC;AACtD,cAAc,iCAAiC,CAAC;AAChD,cAAc,iCAAiC,CAAC;AAEhD,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAE5D,OAAO,EACL,sBAAsB,EACtB,mBAAmB,EACnB,SAAS,EACT,eAAe,EACf,YAAY,EACZ,eAAe,EACf,oBAAoB,EACpB,qBAAqB,EACrB,gBAAgB,EAChB,4BAA4B,EAC5B,kBAAkB,EAClB,SAAS,EACT,WAAW,EACX,eAAe,EACf,iBAAiB,EACjB,gBAAgB,EAChB,sBAAsB,EACtB,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,QAAQ,EACR,IAAI,EACJ,QAAQ,EACR,SAAS,EACT,sBAAsB,EACtB,UAAU,EACV,YAAY,EACZ,aAAa,EACb,MAAM,EACN,UAAU,EACV,eAAe,EACf,qBAAqB,EACrB,aAAa,EACb,2BAA2B,EAC3B,UAAU,EACV,kBAAkB,EAClB,IAAI,EACJ,cAAc,EACd,eAAe,EACf,MAAM,EACN,eAAe,EACf,OAAO,EACP,eAAe,EACf,gBAAgB,EAChB,SAAS,EACT,KAAK,EACL,WAAW,EACX,oBAAoB,EACpB,QAAQ,EACR,yBAAyB,EACzB,qBAAqB,EACrB,WAAW,EACX,eAAe,EACf,sBAAsB,EACtB,gBAAgB,EAChB,YAAY,EACZ,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,aAAa,EACb,mBAAmB,EACnB,eAAe,EACf,iBAAiB,EACjB,UAAU,EACV,UAAU,EACV,aAAa,EACb,iBAAiB,EACjB,KAAK,GACN,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC;IACtC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,aAAa,CAAC;CACxB,CAAC,CAAC;AAEH,MAAM,MAAM,gBAAgB,CAAC,OAAO,IAAI,OAAO,CAAC;IAC9C;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC,CAAC"}
|
|
@@ -8,7 +8,7 @@ import type { Region as PersonalizationRegion } from '@algolia/client-personaliz
|
|
|
8
8
|
import type { RecommendClient } from '@algolia/recommend';
|
|
9
9
|
import type { InitClientOptions, InitClientRegion, GenerateSecuredApiKeyOptions, GetSecuredApiKeyRemainingValidityOptions } from './models';
|
|
10
10
|
export * from './models';
|
|
11
|
-
export declare const apiClientVersion = "5.1
|
|
11
|
+
export declare const apiClientVersion = "5.2.1";
|
|
12
12
|
/**
|
|
13
13
|
* The client type.
|
|
14
14
|
*/
|
|
@@ -27,7 +27,7 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
|
|
|
27
27
|
* @param generateSecuredApiKey.parentApiKey - The base API key from which to generate the new secured one.
|
|
28
28
|
* @param generateSecuredApiKey.restrictions - A set of properties defining the restrictions of the secured API key.
|
|
29
29
|
*/
|
|
30
|
-
generateSecuredApiKey({ parentApiKey, restrictions
|
|
30
|
+
generateSecuredApiKey({ parentApiKey, restrictions }: GenerateSecuredApiKeyOptions): string;
|
|
31
31
|
/**
|
|
32
32
|
* Helper: Retrieves the remaining validity of the previous generated `securedApiKey`, the `ValidUntil` parameter must have been provided.
|
|
33
33
|
*
|
|
@@ -35,7 +35,7 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
|
|
|
35
35
|
* @param getSecuredApiKeyRemainingValidity - The `getSecuredApiKeyRemainingValidity` object.
|
|
36
36
|
* @param getSecuredApiKeyRemainingValidity.securedApiKey - The secured API key generated with the `generateSecuredApiKey` method.
|
|
37
37
|
*/
|
|
38
|
-
getSecuredApiKeyRemainingValidity({ securedApiKey
|
|
38
|
+
getSecuredApiKeyRemainingValidity({ securedApiKey }: GetSecuredApiKeyRemainingValidityOptions): number;
|
|
39
39
|
transporter: import("@algolia/client-common").Transporter;
|
|
40
40
|
appId: string;
|
|
41
41
|
clearCache(): Promise<void>;
|
|
@@ -46,7 +46,7 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
|
|
|
46
46
|
browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: import("@algolia/client-search/model/clientMethodProps").BrowseOptions<import("@algolia/client-search/model/browseResponse").BrowseResponse<T>> & import("@algolia/client-search/model/clientMethodProps").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/browseResponse").BrowseResponse<T>>;
|
|
47
47
|
browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: import("@algolia/client-search/model/clientMethodProps").BrowseOptions<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse> & import("@algolia/client-search/model/clientMethodProps").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse>;
|
|
48
48
|
browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }: import("@algolia/client-search/model/clientMethodProps").BrowseOptions<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse> & import("@algolia/client-search/model/clientMethodProps").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>;
|
|
49
|
-
chunkedBatch({ indexName, objects, action, waitForTasks, batchSize
|
|
49
|
+
chunkedBatch({ indexName, objects, action, waitForTasks, batchSize }: import("@algolia/client-search/model/clientMethodProps").ChunkedBatchOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
|
|
50
50
|
saveObjects({ indexName, objects }: import("@algolia/client-search/model/clientMethodProps").SaveObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
|
|
51
51
|
deleteObjects({ indexName, objectIDs }: import("@algolia/client-search/model/clientMethodProps").DeleteObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
|
|
52
52
|
partialUpdateObjects({ indexName, objects, createIfNotExists }: import("@algolia/client-search/model/clientMethodProps").PartialUpdateObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
|
|
@@ -63,15 +63,15 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
|
|
|
63
63
|
assignUserId({ xAlgoliaUserID, assignUserIdParams }: import("@algolia/client-search/model/clientMethodProps").AssignUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/createdAtResponse").CreatedAtResponse>;
|
|
64
64
|
batch({ indexName, batchWriteParams }: import("@algolia/client-search/model/clientMethodProps").BatchProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse>;
|
|
65
65
|
batchAssignUserIds({ xAlgoliaUserID, batchAssignUserIdsParams }: import("@algolia/client-search/model/clientMethodProps").BatchAssignUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/createdAtResponse").CreatedAtResponse>;
|
|
66
|
-
batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams
|
|
66
|
+
batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams }: import("@algolia/client-search/model/clientMethodProps").BatchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
67
67
|
browse<T>({ indexName, browseParams }: import("@algolia/client-search/model/clientMethodProps").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/browseResponse").BrowseResponse<T>>;
|
|
68
68
|
clearObjects({ indexName }: import("@algolia/client-search/model/clientMethodProps").ClearObjectsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
69
69
|
clearRules({ indexName, forwardToReplicas }: import("@algolia/client-search/model/clientMethodProps").ClearRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
70
70
|
clearSynonyms({ indexName, forwardToReplicas }: import("@algolia/client-search/model/clientMethodProps").ClearSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
71
|
-
customDelete({ path, parameters }: import("@algolia/client-search/model/clientMethodProps").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string,
|
|
72
|
-
customGet({ path, parameters }: import("@algolia/client-search/model/clientMethodProps").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string,
|
|
73
|
-
customPost({ path, parameters, body }: import("@algolia/client-search/model/clientMethodProps").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string,
|
|
74
|
-
customPut({ path, parameters, body }: import("@algolia/client-search/model/clientMethodProps").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string,
|
|
71
|
+
customDelete({ path, parameters }: import("@algolia/client-search/model/clientMethodProps").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, unknown>>;
|
|
72
|
+
customGet({ path, parameters }: import("@algolia/client-search/model/clientMethodProps").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, unknown>>;
|
|
73
|
+
customPost({ path, parameters, body }: import("@algolia/client-search/model/clientMethodProps").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, unknown>>;
|
|
74
|
+
customPut({ path, parameters, body }: import("@algolia/client-search/model/clientMethodProps").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, unknown>>;
|
|
75
75
|
deleteApiKey({ key }: import("@algolia/client-search/model/clientMethodProps").DeleteApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/deleteApiKeyResponse").DeleteApiKeyResponse>;
|
|
76
76
|
deleteBy({ indexName, deleteByParams }: import("@algolia/client-search/model/clientMethodProps").DeleteByProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/deletedAtResponse").DeletedAtResponse>;
|
|
77
77
|
deleteIndex({ indexName }: import("@algolia/client-search/model/clientMethodProps").DeleteIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/deletedAtResponse").DeletedAtResponse>;
|
|
@@ -84,7 +84,7 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
|
|
|
84
84
|
getDictionaryLanguages(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, import("@algolia/client-search/model/languages").Languages>>;
|
|
85
85
|
getDictionarySettings(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/getDictionarySettingsResponse").GetDictionarySettingsResponse>;
|
|
86
86
|
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>;
|
|
87
|
-
getObject({ indexName, objectID, attributesToRetrieve }: import("@algolia/client-search/model/clientMethodProps").GetObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string,
|
|
87
|
+
getObject({ indexName, objectID, attributesToRetrieve }: import("@algolia/client-search/model/clientMethodProps").GetObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, unknown>>;
|
|
88
88
|
getObjects<T>(getObjectsParams: import("@algolia/client-search/model/getObjectsParams").GetObjectsParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/getObjectsResponse").GetObjectsResponse<T>>;
|
|
89
89
|
getRule({ indexName, objectID }: import("@algolia/client-search/model/clientMethodProps").GetRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/rule").Rule>;
|
|
90
90
|
getSettings({ indexName }: import("@algolia/client-search/model/clientMethodProps").GetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/settingsResponse").SettingsResponse>;
|
|
@@ -100,18 +100,18 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
|
|
|
100
100
|
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>;
|
|
101
101
|
multipleBatch(batchParams: import("@algolia/client-search/model/batchParams").BatchParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/multipleBatchResponse").MultipleBatchResponse>;
|
|
102
102
|
operationIndex({ indexName, operationIndexParams }: import("@algolia/client-search/model/clientMethodProps").OperationIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
103
|
-
partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists
|
|
103
|
+
partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists }: import("@algolia/client-search/model/clientMethodProps").PartialUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/updatedAtWithObjectIdResponse").UpdatedAtWithObjectIdResponse>;
|
|
104
104
|
removeUserId({ userID }: import("@algolia/client-search/model/clientMethodProps").RemoveUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/removeUserIdResponse").RemoveUserIdResponse>;
|
|
105
105
|
replaceSources({ source }: import("@algolia/client-search/model/clientMethodProps").ReplaceSourcesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/replaceSourceResponse").ReplaceSourceResponse>;
|
|
106
106
|
restoreApiKey({ key }: import("@algolia/client-search/model/clientMethodProps").RestoreApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/addApiKeyResponse").AddApiKeyResponse>;
|
|
107
107
|
saveObject({ indexName, body }: import("@algolia/client-search/model/clientMethodProps").SaveObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/saveObjectResponse").SaveObjectResponse>;
|
|
108
108
|
saveRule({ indexName, objectID, rule, forwardToReplicas }: import("@algolia/client-search/model/clientMethodProps").SaveRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/updatedRuleResponse").UpdatedRuleResponse>;
|
|
109
|
-
saveRules({ indexName, rules, forwardToReplicas, clearExistingRules
|
|
109
|
+
saveRules({ indexName, rules, forwardToReplicas, clearExistingRules }: import("@algolia/client-search/model/clientMethodProps").SaveRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
110
110
|
saveSynonym({ indexName, objectID, synonymHit, forwardToReplicas }: import("@algolia/client-search/model/clientMethodProps").SaveSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/saveSynonymResponse").SaveSynonymResponse>;
|
|
111
|
-
saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms
|
|
111
|
+
saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms }: import("@algolia/client-search/model/clientMethodProps").SaveSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
112
112
|
search<T>(searchMethodParams: import("@algolia/client-search/model/clientMethodProps").LegacySearchMethodProps | import("@algolia/client-search/model/searchMethodParams").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/searchResponses").SearchResponses<T>>;
|
|
113
|
-
searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams
|
|
114
|
-
searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest
|
|
113
|
+
searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams }: import("@algolia/client-search/model/clientMethodProps").SearchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/searchDictionaryEntriesResponse").SearchDictionaryEntriesResponse>;
|
|
114
|
+
searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest }: import("@algolia/client-search/model/clientMethodProps").SearchForFacetValuesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/searchForFacetValuesResponse").SearchForFacetValuesResponse>;
|
|
115
115
|
searchRules({ indexName, searchRulesParams }: import("@algolia/client-search/model/clientMethodProps").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse>;
|
|
116
116
|
searchSingleIndex<T>({ indexName, searchParams }: import("@algolia/client-search/model/clientMethodProps").SearchSingleIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/searchResponse").SearchResponse<T>>;
|
|
117
117
|
searchSynonyms({ indexName, searchSynonymsParams }: import("@algolia/client-search/model/clientMethodProps").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>;
|
|
@@ -1 +1 @@
|
|
|
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;
|
|
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;AAE/F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAEjE,OAAO,KAAK,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,+CAA+C,CAAC;AAS/F,OAAO,KAAK,EAAE,aAAa,EAAuB,MAAM,wBAAwB,CAAC;AACjF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,KAAK,EAAE,MAAM,IAAI,qBAAqB,EAAE,MAAM,2DAA2D,CAAC;AAMjH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAI1D,OAAO,KAAK,EACV,iBAAiB,EACjB,gBAAgB,EAChB,4BAA4B,EAC5B,wCAAwC,EACzC,MAAM,UAAU,CAAC;AAElB,cAAc,UAAU,CAAC;AAEzB,eAAO,MAAM,gBAAgB,UAAsB,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC;AAG7D,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;;kCA+C9C,iBAAiB,GAAG,gBAAgB,CAAC,eAAe,CAAC,KAAQ,eAAe;kCAf5E,iBAAiB,GAAG,gBAAgB,CAAC,eAAe,CAAC,KAAQ,eAAe;uCA+BjG,iBAAiB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,CAAC,KACjF,qBAAqB;kCAxCY,iBAAiB,KAAQ,eAAe;IAoE1E;;;;;;;OAOG;0DACwD,4BAA4B,GAAG,MAAM;IA6BhG;;;;;;OAMG;yDACkD,wCAAwC,GAAG,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAYzG"}
|