algoliasearch 5.8.1 → 5.9.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 +5 -5
- package/builds/browser.ts +69 -20
- package/builds/fetch.ts +69 -20
- package/builds/models.ts +65 -18
- package/builds/node.ts +69 -20
- package/dist/algoliasearch.umd.js +15 -8
- package/dist/browser.d.ts +32 -21
- package/dist/browser.js +53 -6
- package/dist/browser.js.map +1 -1
- package/dist/browser.min.js +1 -1
- package/dist/browser.min.js.map +1 -1
- package/dist/fetch.d.ts +32 -21
- package/dist/fetch.js +53 -6
- package/dist/fetch.js.map +1 -1
- package/dist/lite/browser.d.ts +12 -8
- package/dist/lite/builds/browser.js +1 -1
- package/dist/lite/builds/browser.js.map +1 -1
- package/dist/lite/builds/browser.min.js +1 -1
- package/dist/lite/builds/browser.min.js.map +1 -1
- package/dist/lite/builds/browser.umd.js +1 -1
- package/dist/lite/builds/node.cjs +1 -1
- package/dist/lite/builds/node.cjs.map +1 -1
- package/dist/lite/builds/node.js +1 -1
- package/dist/lite/builds/node.js.map +1 -1
- package/dist/lite/node.d.cts +12 -8
- package/dist/lite/node.d.ts +12 -8
- package/dist/lite/src/liteClient.cjs +1 -1
- package/dist/lite/src/liteClient.cjs.map +1 -1
- package/dist/lite/src/liteClient.js +1 -1
- package/dist/lite/src/liteClient.js.map +1 -1
- package/dist/node.cjs +52 -9
- package/dist/node.cjs.map +1 -1
- package/dist/node.d.cts +32 -21
- package/dist/node.d.ts +32 -21
- package/dist/node.js +53 -6
- package/dist/node.js.map +1 -1
- package/lite/model/baseGetApiKeyResponse.ts +1 -1
- package/lite/model/baseIndexSettings.ts +2 -2
- package/lite/model/baseRecommendIndexSettings.ts +1 -1
- package/lite/model/baseSearchResponse.ts +5 -0
- package/lite/model/indexSettingsAsSearchParams.ts +1 -1
- package/lite/model/recommendHit.ts +1 -1
- package/lite/model/trendingFacetHit.ts +1 -1
- package/lite/src/liteClient.ts +1 -1
- package/package.json +18 -14
package/README.md
CHANGED
|
@@ -38,11 +38,11 @@ All of our clients comes with type definition, and are available for both browse
|
|
|
38
38
|
### With a package manager
|
|
39
39
|
|
|
40
40
|
```bash
|
|
41
|
-
yarn add algoliasearch@5.
|
|
41
|
+
yarn add algoliasearch@5.9.1
|
|
42
42
|
# or
|
|
43
|
-
npm install algoliasearch@5.
|
|
43
|
+
npm install algoliasearch@5.9.1
|
|
44
44
|
# or
|
|
45
|
-
pnpm add algoliasearch@5.
|
|
45
|
+
pnpm add algoliasearch@5.9.1
|
|
46
46
|
```
|
|
47
47
|
|
|
48
48
|
### Without a package manager
|
|
@@ -51,10 +51,10 @@ Add the following JavaScript snippet to the <head> of your website:
|
|
|
51
51
|
|
|
52
52
|
```html
|
|
53
53
|
// for the full client
|
|
54
|
-
<script src="https://cdn.jsdelivr.net/npm/algoliasearch@5.
|
|
54
|
+
<script src="https://cdn.jsdelivr.net/npm/algoliasearch@5.9.1/dist/algoliasearch.umd.js"></script>
|
|
55
55
|
|
|
56
56
|
// for the lite client
|
|
57
|
-
<script src="https://cdn.jsdelivr.net/npm/algoliasearch@5.
|
|
57
|
+
<script src="https://cdn.jsdelivr.net/npm/algoliasearch@5.9.1/dist/lite/builds/browser.umd.js"></script>
|
|
58
58
|
```
|
|
59
59
|
|
|
60
60
|
### Usage
|
package/builds/browser.ts
CHANGED
|
@@ -1,29 +1,47 @@
|
|
|
1
1
|
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
|
-
import type { AbtestingClient, Region as AbtestingRegion } from '@algolia/client-abtesting';
|
|
4
|
-
import type { AnalyticsClient, Region as AnalyticsRegion } from '@algolia/client-analytics';
|
|
5
3
|
import type { ClientOptions } from '@algolia/client-common';
|
|
6
|
-
import type { PersonalizationClient, Region as PersonalizationRegion } from '@algolia/client-personalization';
|
|
7
4
|
import type { SearchClient } from '@algolia/client-search';
|
|
8
|
-
import
|
|
5
|
+
import { searchClient } from '@algolia/client-search';
|
|
9
6
|
|
|
7
|
+
import type { AbtestingClient } from '@algolia/client-abtesting';
|
|
10
8
|
import { abtestingClient } from '@algolia/client-abtesting';
|
|
9
|
+
import type { AnalyticsClient } from '@algolia/client-analytics';
|
|
11
10
|
import { analyticsClient } from '@algolia/client-analytics';
|
|
11
|
+
import type { InsightsClient } from '@algolia/client-insights';
|
|
12
|
+
import { insightsClient } from '@algolia/client-insights';
|
|
13
|
+
import type { PersonalizationClient } from '@algolia/client-personalization';
|
|
12
14
|
import { personalizationClient } from '@algolia/client-personalization';
|
|
13
|
-
import {
|
|
15
|
+
import type { QuerySuggestionsClient } from '@algolia/client-query-suggestions';
|
|
16
|
+
import { querySuggestionsClient } from '@algolia/client-query-suggestions';
|
|
17
|
+
import type { IngestionClient } from '@algolia/ingestion';
|
|
18
|
+
import { ingestionClient } from '@algolia/ingestion';
|
|
19
|
+
import type { MonitoringClient } from '@algolia/monitoring';
|
|
20
|
+
import { monitoringClient } from '@algolia/monitoring';
|
|
21
|
+
import type { RecommendClient } from '@algolia/recommend';
|
|
14
22
|
import { recommendClient } from '@algolia/recommend';
|
|
15
23
|
|
|
16
|
-
import type {
|
|
24
|
+
import type {
|
|
25
|
+
AbtestingRegionOptions,
|
|
26
|
+
AnalyticsRegionOptions,
|
|
27
|
+
IngestionRegionOptions,
|
|
28
|
+
InitClientOptions,
|
|
29
|
+
InsightsRegionOptions,
|
|
30
|
+
PersonalizationRegionOptions,
|
|
31
|
+
QuerySuggestionsRegionOptions,
|
|
32
|
+
} from './models';
|
|
17
33
|
|
|
18
34
|
export * from './models';
|
|
19
35
|
|
|
20
36
|
export type Algoliasearch = SearchClient & {
|
|
21
|
-
|
|
22
|
-
initAnalytics: (initOptions
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
) => PersonalizationClient;
|
|
37
|
+
initAbtesting: (initOptions: InitClientOptions & AbtestingRegionOptions) => AbtestingClient;
|
|
38
|
+
initAnalytics: (initOptions: InitClientOptions & AnalyticsRegionOptions) => AnalyticsClient;
|
|
39
|
+
initIngestion: (initOptions: InitClientOptions & IngestionRegionOptions) => IngestionClient;
|
|
40
|
+
initInsights: (initOptions: InitClientOptions & InsightsRegionOptions) => InsightsClient;
|
|
41
|
+
initMonitoring: (initOptions: InitClientOptions) => MonitoringClient;
|
|
42
|
+
initPersonalization: (initOptions: InitClientOptions & PersonalizationRegionOptions) => PersonalizationClient;
|
|
43
|
+
initQuerySuggestions: (initOptions: InitClientOptions & QuerySuggestionsRegionOptions) => QuerySuggestionsClient;
|
|
44
|
+
initRecommend: (initOptions: InitClientOptions) => RecommendClient;
|
|
27
45
|
};
|
|
28
46
|
|
|
29
47
|
export function algoliasearch(appId: string, apiKey: string, options?: ClientOptions): Algoliasearch {
|
|
@@ -39,17 +57,24 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt
|
|
|
39
57
|
|
|
40
58
|
return {
|
|
41
59
|
...client,
|
|
60
|
+
|
|
42
61
|
/**
|
|
43
62
|
* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
|
|
44
63
|
*/
|
|
45
64
|
get _ua(): string {
|
|
46
65
|
return client.transporter.algoliaAgent.value;
|
|
47
66
|
},
|
|
48
|
-
|
|
49
|
-
|
|
67
|
+
|
|
68
|
+
initAbtesting: (initOptions: InitClientOptions & AbtestingRegionOptions): AbtestingClient => {
|
|
69
|
+
return abtestingClient(
|
|
70
|
+
initOptions.appId || appId,
|
|
71
|
+
initOptions.apiKey || apiKey,
|
|
72
|
+
initOptions.region,
|
|
73
|
+
initOptions.options,
|
|
74
|
+
);
|
|
50
75
|
},
|
|
51
76
|
|
|
52
|
-
initAnalytics: (initOptions: InitClientOptions &
|
|
77
|
+
initAnalytics: (initOptions: InitClientOptions & AnalyticsRegionOptions): AnalyticsClient => {
|
|
53
78
|
return analyticsClient(
|
|
54
79
|
initOptions.appId || appId,
|
|
55
80
|
initOptions.apiKey || apiKey,
|
|
@@ -58,8 +83,8 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt
|
|
|
58
83
|
);
|
|
59
84
|
},
|
|
60
85
|
|
|
61
|
-
|
|
62
|
-
return
|
|
86
|
+
initIngestion: (initOptions: InitClientOptions & IngestionRegionOptions): IngestionClient => {
|
|
87
|
+
return ingestionClient(
|
|
63
88
|
initOptions.appId || appId,
|
|
64
89
|
initOptions.apiKey || apiKey,
|
|
65
90
|
initOptions.region,
|
|
@@ -67,9 +92,20 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt
|
|
|
67
92
|
);
|
|
68
93
|
},
|
|
69
94
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
95
|
+
initInsights: (initOptions: InitClientOptions & InsightsRegionOptions): InsightsClient => {
|
|
96
|
+
return insightsClient(
|
|
97
|
+
initOptions.appId || appId,
|
|
98
|
+
initOptions.apiKey || apiKey,
|
|
99
|
+
initOptions.region,
|
|
100
|
+
initOptions.options,
|
|
101
|
+
);
|
|
102
|
+
},
|
|
103
|
+
|
|
104
|
+
initMonitoring: (initOptions: InitClientOptions): MonitoringClient => {
|
|
105
|
+
return monitoringClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options);
|
|
106
|
+
},
|
|
107
|
+
|
|
108
|
+
initPersonalization: (initOptions: InitClientOptions & PersonalizationRegionOptions): PersonalizationClient => {
|
|
73
109
|
return personalizationClient(
|
|
74
110
|
initOptions.appId || appId,
|
|
75
111
|
initOptions.apiKey || apiKey,
|
|
@@ -77,5 +113,18 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt
|
|
|
77
113
|
initOptions.options,
|
|
78
114
|
);
|
|
79
115
|
},
|
|
116
|
+
|
|
117
|
+
initQuerySuggestions: (initOptions: InitClientOptions & QuerySuggestionsRegionOptions): QuerySuggestionsClient => {
|
|
118
|
+
return querySuggestionsClient(
|
|
119
|
+
initOptions.appId || appId,
|
|
120
|
+
initOptions.apiKey || apiKey,
|
|
121
|
+
initOptions.region,
|
|
122
|
+
initOptions.options,
|
|
123
|
+
);
|
|
124
|
+
},
|
|
125
|
+
|
|
126
|
+
initRecommend: (initOptions: InitClientOptions): RecommendClient => {
|
|
127
|
+
return recommendClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options);
|
|
128
|
+
},
|
|
80
129
|
};
|
|
81
130
|
}
|
package/builds/fetch.ts
CHANGED
|
@@ -1,29 +1,47 @@
|
|
|
1
1
|
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
|
-
import type { AbtestingClient, Region as AbtestingRegion } from '@algolia/client-abtesting';
|
|
4
|
-
import type { AnalyticsClient, Region as AnalyticsRegion } from '@algolia/client-analytics';
|
|
5
3
|
import type { ClientOptions } from '@algolia/client-common';
|
|
6
|
-
import type { PersonalizationClient, Region as PersonalizationRegion } from '@algolia/client-personalization';
|
|
7
4
|
import type { SearchClient } from '@algolia/client-search';
|
|
8
|
-
import
|
|
5
|
+
import { searchClient } from '@algolia/client-search';
|
|
9
6
|
|
|
7
|
+
import type { AbtestingClient } from '@algolia/client-abtesting';
|
|
10
8
|
import { abtestingClient } from '@algolia/client-abtesting';
|
|
9
|
+
import type { AnalyticsClient } from '@algolia/client-analytics';
|
|
11
10
|
import { analyticsClient } from '@algolia/client-analytics';
|
|
11
|
+
import type { InsightsClient } from '@algolia/client-insights';
|
|
12
|
+
import { insightsClient } from '@algolia/client-insights';
|
|
13
|
+
import type { PersonalizationClient } from '@algolia/client-personalization';
|
|
12
14
|
import { personalizationClient } from '@algolia/client-personalization';
|
|
13
|
-
import {
|
|
15
|
+
import type { QuerySuggestionsClient } from '@algolia/client-query-suggestions';
|
|
16
|
+
import { querySuggestionsClient } from '@algolia/client-query-suggestions';
|
|
17
|
+
import type { IngestionClient } from '@algolia/ingestion';
|
|
18
|
+
import { ingestionClient } from '@algolia/ingestion';
|
|
19
|
+
import type { MonitoringClient } from '@algolia/monitoring';
|
|
20
|
+
import { monitoringClient } from '@algolia/monitoring';
|
|
21
|
+
import type { RecommendClient } from '@algolia/recommend';
|
|
14
22
|
import { recommendClient } from '@algolia/recommend';
|
|
15
23
|
|
|
16
|
-
import type {
|
|
24
|
+
import type {
|
|
25
|
+
AbtestingRegionOptions,
|
|
26
|
+
AnalyticsRegionOptions,
|
|
27
|
+
IngestionRegionOptions,
|
|
28
|
+
InitClientOptions,
|
|
29
|
+
InsightsRegionOptions,
|
|
30
|
+
PersonalizationRegionOptions,
|
|
31
|
+
QuerySuggestionsRegionOptions,
|
|
32
|
+
} from './models';
|
|
17
33
|
|
|
18
34
|
export * from './models';
|
|
19
35
|
|
|
20
36
|
export type Algoliasearch = SearchClient & {
|
|
21
|
-
|
|
22
|
-
initAnalytics: (initOptions
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
) => PersonalizationClient;
|
|
37
|
+
initAbtesting: (initOptions: InitClientOptions & AbtestingRegionOptions) => AbtestingClient;
|
|
38
|
+
initAnalytics: (initOptions: InitClientOptions & AnalyticsRegionOptions) => AnalyticsClient;
|
|
39
|
+
initIngestion: (initOptions: InitClientOptions & IngestionRegionOptions) => IngestionClient;
|
|
40
|
+
initInsights: (initOptions: InitClientOptions & InsightsRegionOptions) => InsightsClient;
|
|
41
|
+
initMonitoring: (initOptions: InitClientOptions) => MonitoringClient;
|
|
42
|
+
initPersonalization: (initOptions: InitClientOptions & PersonalizationRegionOptions) => PersonalizationClient;
|
|
43
|
+
initQuerySuggestions: (initOptions: InitClientOptions & QuerySuggestionsRegionOptions) => QuerySuggestionsClient;
|
|
44
|
+
initRecommend: (initOptions: InitClientOptions) => RecommendClient;
|
|
27
45
|
};
|
|
28
46
|
|
|
29
47
|
export function algoliasearch(appId: string, apiKey: string, options?: ClientOptions): Algoliasearch {
|
|
@@ -39,17 +57,24 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt
|
|
|
39
57
|
|
|
40
58
|
return {
|
|
41
59
|
...client,
|
|
60
|
+
|
|
42
61
|
/**
|
|
43
62
|
* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
|
|
44
63
|
*/
|
|
45
64
|
get _ua(): string {
|
|
46
65
|
return client.transporter.algoliaAgent.value;
|
|
47
66
|
},
|
|
48
|
-
|
|
49
|
-
|
|
67
|
+
|
|
68
|
+
initAbtesting: (initOptions: InitClientOptions & AbtestingRegionOptions): AbtestingClient => {
|
|
69
|
+
return abtestingClient(
|
|
70
|
+
initOptions.appId || appId,
|
|
71
|
+
initOptions.apiKey || apiKey,
|
|
72
|
+
initOptions.region,
|
|
73
|
+
initOptions.options,
|
|
74
|
+
);
|
|
50
75
|
},
|
|
51
76
|
|
|
52
|
-
initAnalytics: (initOptions: InitClientOptions &
|
|
77
|
+
initAnalytics: (initOptions: InitClientOptions & AnalyticsRegionOptions): AnalyticsClient => {
|
|
53
78
|
return analyticsClient(
|
|
54
79
|
initOptions.appId || appId,
|
|
55
80
|
initOptions.apiKey || apiKey,
|
|
@@ -58,8 +83,8 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt
|
|
|
58
83
|
);
|
|
59
84
|
},
|
|
60
85
|
|
|
61
|
-
|
|
62
|
-
return
|
|
86
|
+
initIngestion: (initOptions: InitClientOptions & IngestionRegionOptions): IngestionClient => {
|
|
87
|
+
return ingestionClient(
|
|
63
88
|
initOptions.appId || appId,
|
|
64
89
|
initOptions.apiKey || apiKey,
|
|
65
90
|
initOptions.region,
|
|
@@ -67,9 +92,20 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt
|
|
|
67
92
|
);
|
|
68
93
|
},
|
|
69
94
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
95
|
+
initInsights: (initOptions: InitClientOptions & InsightsRegionOptions): InsightsClient => {
|
|
96
|
+
return insightsClient(
|
|
97
|
+
initOptions.appId || appId,
|
|
98
|
+
initOptions.apiKey || apiKey,
|
|
99
|
+
initOptions.region,
|
|
100
|
+
initOptions.options,
|
|
101
|
+
);
|
|
102
|
+
},
|
|
103
|
+
|
|
104
|
+
initMonitoring: (initOptions: InitClientOptions): MonitoringClient => {
|
|
105
|
+
return monitoringClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options);
|
|
106
|
+
},
|
|
107
|
+
|
|
108
|
+
initPersonalization: (initOptions: InitClientOptions & PersonalizationRegionOptions): PersonalizationClient => {
|
|
73
109
|
return personalizationClient(
|
|
74
110
|
initOptions.appId || appId,
|
|
75
111
|
initOptions.apiKey || apiKey,
|
|
@@ -77,5 +113,18 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt
|
|
|
77
113
|
initOptions.options,
|
|
78
114
|
);
|
|
79
115
|
},
|
|
116
|
+
|
|
117
|
+
initQuerySuggestions: (initOptions: InitClientOptions & QuerySuggestionsRegionOptions): QuerySuggestionsClient => {
|
|
118
|
+
return querySuggestionsClient(
|
|
119
|
+
initOptions.appId || appId,
|
|
120
|
+
initOptions.apiKey || apiKey,
|
|
121
|
+
initOptions.region,
|
|
122
|
+
initOptions.options,
|
|
123
|
+
);
|
|
124
|
+
},
|
|
125
|
+
|
|
126
|
+
initRecommend: (initOptions: InitClientOptions): RecommendClient => {
|
|
127
|
+
return recommendClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options);
|
|
128
|
+
},
|
|
80
129
|
};
|
|
81
130
|
}
|
package/builds/models.ts
CHANGED
|
@@ -1,9 +1,24 @@
|
|
|
1
1
|
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
|
-
import type { Region as
|
|
4
|
-
import type { Region as AnalyticsRegion } from '@algolia/client-analytics';
|
|
3
|
+
import type { Region as AbtestingRegion, RegionOptions as AbtestingRegionOptions } from '@algolia/client-abtesting';
|
|
4
|
+
import type { Region as AnalyticsRegion, RegionOptions as AnalyticsRegionOptions } from '@algolia/client-analytics';
|
|
5
|
+
import type { Region as InsightsRegion, RegionOptions as InsightsRegionOptions } from '@algolia/client-insights';
|
|
6
|
+
import type { Region as IngestionRegion, RegionOptions as IngestionRegionOptions } from '@algolia/ingestion';
|
|
7
|
+
|
|
8
|
+
import type {
|
|
9
|
+
Region as PersonalizationRegion,
|
|
10
|
+
RegionOptions as PersonalizationRegionOptions,
|
|
11
|
+
} from '@algolia/client-personalization';
|
|
12
|
+
import type {
|
|
13
|
+
Region as QuerySuggestionsRegion,
|
|
14
|
+
RegionOptions as QuerySuggestionsRegionOptions,
|
|
15
|
+
} from '@algolia/client-query-suggestions';
|
|
16
|
+
|
|
17
|
+
import { Status } from '@algolia/client-abtesting';
|
|
5
18
|
import type { ClientOptions } from '@algolia/client-common';
|
|
19
|
+
import { EventType } from '@algolia/client-personalization';
|
|
6
20
|
import type {
|
|
21
|
+
Action,
|
|
7
22
|
AdvancedSyntaxFeatures,
|
|
8
23
|
AlternativesAsExact,
|
|
9
24
|
Anchoring,
|
|
@@ -31,6 +46,7 @@ import type {
|
|
|
31
46
|
CustomGetProps,
|
|
32
47
|
CustomPostProps,
|
|
33
48
|
CustomPutProps,
|
|
49
|
+
DeleteSourceProps,
|
|
34
50
|
DeletedAtResponse,
|
|
35
51
|
Distinct,
|
|
36
52
|
Edit,
|
|
@@ -40,14 +56,16 @@ import type {
|
|
|
40
56
|
Exhaustive,
|
|
41
57
|
FacetFilters,
|
|
42
58
|
FacetOrdering,
|
|
43
|
-
Facets,
|
|
44
59
|
FacetStats,
|
|
60
|
+
Facets,
|
|
61
|
+
GetTaskProps,
|
|
45
62
|
HighlightResult,
|
|
46
63
|
HighlightResultOption,
|
|
47
64
|
IgnorePlurals,
|
|
48
65
|
IndexSettingsAsSearchParams,
|
|
49
|
-
|
|
66
|
+
Languages,
|
|
50
67
|
MatchLevel,
|
|
68
|
+
MatchedGeoLocation,
|
|
51
69
|
Mode,
|
|
52
70
|
NumericFilters,
|
|
53
71
|
OptionalFilters,
|
|
@@ -59,6 +77,7 @@ import type {
|
|
|
59
77
|
QueryType,
|
|
60
78
|
Range,
|
|
61
79
|
RankingInfo,
|
|
80
|
+
ReRankingApplyFilter,
|
|
62
81
|
Redirect,
|
|
63
82
|
RedirectRuleIndexData,
|
|
64
83
|
RedirectRuleIndexMetadata,
|
|
@@ -66,7 +85,6 @@ import type {
|
|
|
66
85
|
RemoveStopWords,
|
|
67
86
|
RemoveWordsIfNoResults,
|
|
68
87
|
RenderingContent,
|
|
69
|
-
ReRankingApplyFilter,
|
|
70
88
|
SearchPagination,
|
|
71
89
|
SearchParams,
|
|
72
90
|
SearchParamsObject,
|
|
@@ -75,6 +93,7 @@ import type {
|
|
|
75
93
|
SnippetResult,
|
|
76
94
|
SnippetResultOption,
|
|
77
95
|
SortRemainingBy,
|
|
96
|
+
Source,
|
|
78
97
|
SupportedLanguage,
|
|
79
98
|
TagFilters,
|
|
80
99
|
TaskStatus,
|
|
@@ -86,21 +105,40 @@ import type {
|
|
|
86
105
|
} from '@algolia/client-search';
|
|
87
106
|
import { apiClientVersion } from '@algolia/client-search';
|
|
88
107
|
|
|
89
|
-
type Region =
|
|
108
|
+
type Region =
|
|
109
|
+
| AbtestingRegion
|
|
110
|
+
| AnalyticsRegion
|
|
111
|
+
| IngestionRegion
|
|
112
|
+
| InsightsRegion
|
|
113
|
+
| PersonalizationRegion
|
|
114
|
+
| QuerySuggestionsRegion;
|
|
115
|
+
type RegionOptions =
|
|
116
|
+
| AbtestingRegionOptions
|
|
117
|
+
| AnalyticsRegionOptions
|
|
118
|
+
| IngestionRegionOptions
|
|
119
|
+
| InsightsRegionOptions
|
|
120
|
+
| PersonalizationRegionOptions
|
|
121
|
+
| QuerySuggestionsRegionOptions;
|
|
90
122
|
|
|
91
123
|
export * from '@algolia/client-abtesting';
|
|
92
124
|
export * from '@algolia/client-analytics';
|
|
125
|
+
export * from '@algolia/client-insights';
|
|
93
126
|
export * from '@algolia/client-personalization';
|
|
127
|
+
export * from '@algolia/client-query-suggestions';
|
|
94
128
|
export * from '@algolia/client-search';
|
|
129
|
+
export * from '@algolia/ingestion';
|
|
130
|
+
export * from '@algolia/monitoring';
|
|
95
131
|
export * from '@algolia/recommend';
|
|
96
132
|
|
|
97
133
|
export {
|
|
98
|
-
|
|
134
|
+
AbtestingRegion,
|
|
135
|
+
AbtestingRegionOptions,
|
|
136
|
+
Action,
|
|
99
137
|
AdvancedSyntaxFeatures,
|
|
100
138
|
AlternativesAsExact,
|
|
101
139
|
AnalyticsRegion,
|
|
140
|
+
AnalyticsRegionOptions,
|
|
102
141
|
Anchoring,
|
|
103
|
-
apiClientVersion,
|
|
104
142
|
AroundPrecision,
|
|
105
143
|
AroundRadius,
|
|
106
144
|
AroundRadiusAll,
|
|
@@ -125,43 +163,56 @@ export {
|
|
|
125
163
|
CustomGetProps,
|
|
126
164
|
CustomPostProps,
|
|
127
165
|
CustomPutProps,
|
|
166
|
+
DeleteSourceProps,
|
|
128
167
|
DeletedAtResponse,
|
|
129
168
|
Distinct,
|
|
130
169
|
Edit,
|
|
131
170
|
EditType,
|
|
132
171
|
ErrorBase,
|
|
172
|
+
EventType,
|
|
133
173
|
ExactOnSingleWordQuery,
|
|
134
174
|
Exhaustive,
|
|
135
175
|
FacetFilters,
|
|
136
176
|
FacetOrdering,
|
|
137
|
-
Facets,
|
|
138
177
|
FacetStats,
|
|
178
|
+
Facets,
|
|
179
|
+
GetTaskProps,
|
|
139
180
|
HighlightResult,
|
|
140
181
|
HighlightResultOption,
|
|
141
182
|
IgnorePlurals,
|
|
142
183
|
IndexSettingsAsSearchParams,
|
|
143
|
-
|
|
184
|
+
IngestionRegion,
|
|
185
|
+
IngestionRegionOptions,
|
|
186
|
+
InsightsRegion,
|
|
187
|
+
InsightsRegionOptions,
|
|
188
|
+
Languages,
|
|
144
189
|
MatchLevel,
|
|
190
|
+
MatchedGeoLocation,
|
|
145
191
|
Mode,
|
|
146
192
|
NumericFilters,
|
|
147
193
|
OptionalFilters,
|
|
148
194
|
Params,
|
|
149
195
|
Personalization,
|
|
196
|
+
PersonalizationRegion,
|
|
197
|
+
PersonalizationRegionOptions,
|
|
150
198
|
Promote,
|
|
151
199
|
PromoteObjectID,
|
|
152
200
|
PromoteObjectIDs,
|
|
201
|
+
QuerySuggestionsRegion,
|
|
202
|
+
QuerySuggestionsRegionOptions,
|
|
153
203
|
QueryType,
|
|
154
204
|
Range,
|
|
155
205
|
RankingInfo,
|
|
206
|
+
ReRankingApplyFilter,
|
|
156
207
|
Redirect,
|
|
157
208
|
RedirectRuleIndexData,
|
|
158
209
|
RedirectRuleIndexMetadata,
|
|
159
210
|
RedirectURL,
|
|
160
211
|
Region,
|
|
212
|
+
RegionOptions,
|
|
161
213
|
RemoveStopWords,
|
|
162
214
|
RemoveWordsIfNoResults,
|
|
163
215
|
RenderingContent,
|
|
164
|
-
ReRankingApplyFilter,
|
|
165
216
|
SearchPagination,
|
|
166
217
|
SearchParams,
|
|
167
218
|
SearchParamsObject,
|
|
@@ -170,6 +221,8 @@ export {
|
|
|
170
221
|
SnippetResult,
|
|
171
222
|
SnippetResultOption,
|
|
172
223
|
SortRemainingBy,
|
|
224
|
+
Source,
|
|
225
|
+
Status,
|
|
173
226
|
SupportedLanguage,
|
|
174
227
|
TagFilters,
|
|
175
228
|
TaskStatus,
|
|
@@ -178,6 +231,7 @@ export {
|
|
|
178
231
|
TypoToleranceEnum,
|
|
179
232
|
Value,
|
|
180
233
|
Widgets,
|
|
234
|
+
apiClientVersion,
|
|
181
235
|
};
|
|
182
236
|
|
|
183
237
|
/**
|
|
@@ -194,10 +248,3 @@ export type InitClientOptions = Partial<{
|
|
|
194
248
|
apiKey: string;
|
|
195
249
|
options: ClientOptions;
|
|
196
250
|
}>;
|
|
197
|
-
|
|
198
|
-
export type InitClientRegion<TRegion> = Partial<{
|
|
199
|
-
/**
|
|
200
|
-
* Available regions of the initialized client.
|
|
201
|
-
*/
|
|
202
|
-
region: TRegion;
|
|
203
|
-
}>;
|
package/builds/node.ts
CHANGED
|
@@ -1,29 +1,47 @@
|
|
|
1
1
|
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
|
-
import type { AbtestingClient, Region as AbtestingRegion } from '@algolia/client-abtesting';
|
|
4
|
-
import type { AnalyticsClient, Region as AnalyticsRegion } from '@algolia/client-analytics';
|
|
5
3
|
import type { ClientOptions } from '@algolia/client-common';
|
|
6
|
-
import type { PersonalizationClient, Region as PersonalizationRegion } from '@algolia/client-personalization';
|
|
7
4
|
import type { SearchClient } from '@algolia/client-search';
|
|
8
|
-
import
|
|
5
|
+
import { searchClient } from '@algolia/client-search';
|
|
9
6
|
|
|
7
|
+
import type { AbtestingClient } from '@algolia/client-abtesting';
|
|
10
8
|
import { abtestingClient } from '@algolia/client-abtesting';
|
|
9
|
+
import type { AnalyticsClient } from '@algolia/client-analytics';
|
|
11
10
|
import { analyticsClient } from '@algolia/client-analytics';
|
|
11
|
+
import type { InsightsClient } from '@algolia/client-insights';
|
|
12
|
+
import { insightsClient } from '@algolia/client-insights';
|
|
13
|
+
import type { PersonalizationClient } from '@algolia/client-personalization';
|
|
12
14
|
import { personalizationClient } from '@algolia/client-personalization';
|
|
13
|
-
import {
|
|
15
|
+
import type { QuerySuggestionsClient } from '@algolia/client-query-suggestions';
|
|
16
|
+
import { querySuggestionsClient } from '@algolia/client-query-suggestions';
|
|
17
|
+
import type { IngestionClient } from '@algolia/ingestion';
|
|
18
|
+
import { ingestionClient } from '@algolia/ingestion';
|
|
19
|
+
import type { MonitoringClient } from '@algolia/monitoring';
|
|
20
|
+
import { monitoringClient } from '@algolia/monitoring';
|
|
21
|
+
import type { RecommendClient } from '@algolia/recommend';
|
|
14
22
|
import { recommendClient } from '@algolia/recommend';
|
|
15
23
|
|
|
16
|
-
import type {
|
|
24
|
+
import type {
|
|
25
|
+
AbtestingRegionOptions,
|
|
26
|
+
AnalyticsRegionOptions,
|
|
27
|
+
IngestionRegionOptions,
|
|
28
|
+
InitClientOptions,
|
|
29
|
+
InsightsRegionOptions,
|
|
30
|
+
PersonalizationRegionOptions,
|
|
31
|
+
QuerySuggestionsRegionOptions,
|
|
32
|
+
} from './models';
|
|
17
33
|
|
|
18
34
|
export * from './models';
|
|
19
35
|
|
|
20
36
|
export type Algoliasearch = SearchClient & {
|
|
21
|
-
|
|
22
|
-
initAnalytics: (initOptions
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
) => PersonalizationClient;
|
|
37
|
+
initAbtesting: (initOptions: InitClientOptions & AbtestingRegionOptions) => AbtestingClient;
|
|
38
|
+
initAnalytics: (initOptions: InitClientOptions & AnalyticsRegionOptions) => AnalyticsClient;
|
|
39
|
+
initIngestion: (initOptions: InitClientOptions & IngestionRegionOptions) => IngestionClient;
|
|
40
|
+
initInsights: (initOptions: InitClientOptions & InsightsRegionOptions) => InsightsClient;
|
|
41
|
+
initMonitoring: (initOptions: InitClientOptions) => MonitoringClient;
|
|
42
|
+
initPersonalization: (initOptions: InitClientOptions & PersonalizationRegionOptions) => PersonalizationClient;
|
|
43
|
+
initQuerySuggestions: (initOptions: InitClientOptions & QuerySuggestionsRegionOptions) => QuerySuggestionsClient;
|
|
44
|
+
initRecommend: (initOptions: InitClientOptions) => RecommendClient;
|
|
27
45
|
};
|
|
28
46
|
|
|
29
47
|
export function algoliasearch(appId: string, apiKey: string, options?: ClientOptions): Algoliasearch {
|
|
@@ -39,17 +57,24 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt
|
|
|
39
57
|
|
|
40
58
|
return {
|
|
41
59
|
...client,
|
|
60
|
+
|
|
42
61
|
/**
|
|
43
62
|
* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
|
|
44
63
|
*/
|
|
45
64
|
get _ua(): string {
|
|
46
65
|
return client.transporter.algoliaAgent.value;
|
|
47
66
|
},
|
|
48
|
-
|
|
49
|
-
|
|
67
|
+
|
|
68
|
+
initAbtesting: (initOptions: InitClientOptions & AbtestingRegionOptions): AbtestingClient => {
|
|
69
|
+
return abtestingClient(
|
|
70
|
+
initOptions.appId || appId,
|
|
71
|
+
initOptions.apiKey || apiKey,
|
|
72
|
+
initOptions.region,
|
|
73
|
+
initOptions.options,
|
|
74
|
+
);
|
|
50
75
|
},
|
|
51
76
|
|
|
52
|
-
initAnalytics: (initOptions: InitClientOptions &
|
|
77
|
+
initAnalytics: (initOptions: InitClientOptions & AnalyticsRegionOptions): AnalyticsClient => {
|
|
53
78
|
return analyticsClient(
|
|
54
79
|
initOptions.appId || appId,
|
|
55
80
|
initOptions.apiKey || apiKey,
|
|
@@ -58,8 +83,8 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt
|
|
|
58
83
|
);
|
|
59
84
|
},
|
|
60
85
|
|
|
61
|
-
|
|
62
|
-
return
|
|
86
|
+
initIngestion: (initOptions: InitClientOptions & IngestionRegionOptions): IngestionClient => {
|
|
87
|
+
return ingestionClient(
|
|
63
88
|
initOptions.appId || appId,
|
|
64
89
|
initOptions.apiKey || apiKey,
|
|
65
90
|
initOptions.region,
|
|
@@ -67,9 +92,20 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt
|
|
|
67
92
|
);
|
|
68
93
|
},
|
|
69
94
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
95
|
+
initInsights: (initOptions: InitClientOptions & InsightsRegionOptions): InsightsClient => {
|
|
96
|
+
return insightsClient(
|
|
97
|
+
initOptions.appId || appId,
|
|
98
|
+
initOptions.apiKey || apiKey,
|
|
99
|
+
initOptions.region,
|
|
100
|
+
initOptions.options,
|
|
101
|
+
);
|
|
102
|
+
},
|
|
103
|
+
|
|
104
|
+
initMonitoring: (initOptions: InitClientOptions): MonitoringClient => {
|
|
105
|
+
return monitoringClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options);
|
|
106
|
+
},
|
|
107
|
+
|
|
108
|
+
initPersonalization: (initOptions: InitClientOptions & PersonalizationRegionOptions): PersonalizationClient => {
|
|
73
109
|
return personalizationClient(
|
|
74
110
|
initOptions.appId || appId,
|
|
75
111
|
initOptions.apiKey || apiKey,
|
|
@@ -77,5 +113,18 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt
|
|
|
77
113
|
initOptions.options,
|
|
78
114
|
);
|
|
79
115
|
},
|
|
116
|
+
|
|
117
|
+
initQuerySuggestions: (initOptions: InitClientOptions & QuerySuggestionsRegionOptions): QuerySuggestionsClient => {
|
|
118
|
+
return querySuggestionsClient(
|
|
119
|
+
initOptions.appId || appId,
|
|
120
|
+
initOptions.apiKey || apiKey,
|
|
121
|
+
initOptions.region,
|
|
122
|
+
initOptions.options,
|
|
123
|
+
);
|
|
124
|
+
},
|
|
125
|
+
|
|
126
|
+
initRecommend: (initOptions: InitClientOptions): RecommendClient => {
|
|
127
|
+
return recommendClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options);
|
|
128
|
+
},
|
|
80
129
|
};
|
|
81
130
|
}
|