Skip to content

Commit 86603ec

Browse files
authored
Merge branch 'main' into fix/hits-per-page
2 parents 2efdf30 + f3b8108 commit 86603ec

File tree

48 files changed

+460
-220
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+460
-220
lines changed

.eslintignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ composer.json
66
tsconfig.json
77
vendor
88
builddir
9+
foo

.github/workflows/check.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -199,10 +199,10 @@ jobs:
199199
type: specs
200200

201201
- name: Remove generated clients
202-
if: ${{ startsWith(env.head_ref, 'chore/prepare-release-') }}
202+
if: ${{ startsWith(github.head_ref, 'chore/prepare-release-') }}
203203
run: |
204204
cd clients/algoliasearch-client-javascript/packages
205-
ls | grep -v -E "(client-common|requester-*|algoliasearch)" | xargs rm -rf
205+
ls | grep -v -E "(logger-console|client-common|requester-*|algoliasearch)" | xargs rm -rf
206206
cd algoliasearch
207207
ls | grep -v -E "__tests__" | xargs rm -rf
208208
@@ -228,11 +228,11 @@ jobs:
228228
run: cd clients/algoliasearch-client-javascript && yarn test ${{ !contains(fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun, 'algoliasearch') && '--ignore algoliasearch' || '' }}
229229

230230
- name: Test JavaScript bundle size
231-
if: ${{ startsWith(env.head_ref, 'chore/prepare-release-') }}
231+
if: ${{ startsWith(github.head_ref, 'chore/prepare-release-') }}
232232
run: cd clients/algoliasearch-client-javascript && yarn test:size
233233

234234
- name: Test JavaScript bundle and types
235-
if: ${{ startsWith(env.head_ref, 'chore/prepare-release-') }}
235+
if: ${{ startsWith(github.head_ref, 'chore/prepare-release-') }}
236236
run: cd clients/algoliasearch-client-javascript && yarn test:bundle
237237

238238
- name: Remove previous CTS output
@@ -335,7 +335,7 @@ jobs:
335335
run: yarn cli generate ${{ matrix.client.language }} ${{ matrix.client.toRun }}
336336

337337
- name: Update composer.lock
338-
if: ${{ matrix.client.language == 'php' && startsWith(env.head_ref, 'chore/renovateBaseBranch') && matrix.client.isMainVersion }}
338+
if: ${{ matrix.client.language == 'php' && startsWith(github.head_ref, 'chore/renovateBaseBranch') && matrix.client.isMainVersion }}
339339
run: cd ${{ matrix.client.path }} && composer update
340340

341341
- name: Check for file duplicates in Swift

clients/algoliasearch-client-javascript/bundlesize.config.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@
22
"files": [
33
{
44
"path": "packages/algoliasearch/dist/algoliasearch.umd.js",
5-
"maxSize": "9.50KB"
5+
"maxSize": "12.60KB"
66
},
77
{
88
"path": "packages/algoliasearch/dist/lite/builds/browser.umd.js",
99
"maxSize": "3.95KB"
1010
},
1111
{
1212
"path": "packages/client-abtesting/dist/builds/browser.umd.js",
13-
"maxSize": "4.10KB"
13+
"maxSize": "4.15KB"
1414
},
1515
{
1616
"path": "packages/client-analytics/dist/builds/browser.umd.js",
17-
"maxSize": "4.75KB"
17+
"maxSize": "4.85KB"
1818
},
1919
{
2020
"path": "packages/client-insights/dist/builds/browser.umd.js",
@@ -30,7 +30,7 @@
3030
},
3131
{
3232
"path": "packages/client-search/dist/builds/browser.umd.js",
33-
"maxSize": "7.15KB"
33+
"maxSize": "7.25KB"
3434
},
3535
{
3636
"path": "packages/ingestion/dist/builds/browser.umd.js",
@@ -42,7 +42,7 @@
4242
},
4343
{
4444
"path": "packages/recommend/dist/builds/browser.umd.js",
45-
"maxSize": "4.10KB"
45+
"maxSize": "4.15KB"
4646
}
4747
]
4848
}

clients/algoliasearch-client-javascript/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
],
88
"scripts": {
99
"build:all": "lerna run build --include-dependencies",
10-
"build:many": "lerna run build --scope '@algolia/requester-testing' --scope ${0:-'{@algolia/*,algoliasearch}'} --include-dependencies",
10+
"build:many": "lerna run build --scope '@algolia/requester-testing' --scope '@algolia/logger-console' --scope ${0:-'{@algolia/*,algoliasearch}'} --include-dependencies",
1111
"clean": "lerna run clean",
1212
"release:bump": "lerna version ${0:-patch} --no-changelog --no-git-tag-version --no-push --exact --force-publish --yes",
1313
"release:publish": "tsc --project scripts/tsconfig.json && node scripts/dist/scripts/publish.js",
Lines changed: 69 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,47 @@
11
// 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.
22

3-
import type { AbtestingClient, Region as AbtestingRegion } from '@algolia/client-abtesting';
4-
import type { AnalyticsClient, Region as AnalyticsRegion } from '@algolia/client-analytics';
53
import type { ClientOptions } from '@algolia/client-common';
6-
import type { PersonalizationClient, Region as PersonalizationRegion } from '@algolia/client-personalization';
74
import type { SearchClient } from '@algolia/client-search';
8-
import type { RecommendClient } from '@algolia/recommend';
5+
import { searchClient } from '@algolia/client-search';
96

7+
import type { AbtestingClient } from '@algolia/client-abtesting';
108
import { abtestingClient } from '@algolia/client-abtesting';
9+
import type { AnalyticsClient } from '@algolia/client-analytics';
1110
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';
1214
import { personalizationClient } from '@algolia/client-personalization';
13-
import { searchClient } from '@algolia/client-search';
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';
1422
import { recommendClient } from '@algolia/recommend';
1523

16-
import type { InitClientOptions, InitClientRegion } from './models';
24+
import type {
25+
AbtestingRegionOptions,
26+
AnalyticsRegionOptions,
27+
IngestionRegionOptions,
28+
InitClientOptions,
29+
InsightsRegionOptions,
30+
PersonalizationRegionOptions,
31+
QuerySuggestionsRegionOptions,
32+
} from './models';
1733

1834
export * from './models';
1935

2036
export type Algoliasearch = SearchClient & {
21-
initRecommend: (initOptions?: InitClientOptions) => RecommendClient;
22-
initAnalytics: (initOptions?: InitClientOptions & InitClientRegion<AnalyticsRegion>) => AnalyticsClient;
23-
initAbtesting: (initOptions?: InitClientOptions & InitClientRegion<AbtestingRegion>) => AbtestingClient;
24-
initPersonalization: (
25-
initOptions: InitClientOptions & Required<InitClientRegion<PersonalizationRegion>>,
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;
2745
};
2846

2947
export function algoliasearch(appId: string, apiKey: string, options?: ClientOptions): Algoliasearch {
@@ -39,17 +57,24 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt
3957

4058
return {
4159
...client,
60+
4261
/**
4362
* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
4463
*/
4564
get _ua(): string {
4665
return client.transporter.algoliaAgent.value;
4766
},
48-
initRecommend: (initOptions: InitClientOptions = {}): RecommendClient => {
49-
return recommendClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options);
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+
);
5075
},
5176

52-
initAnalytics: (initOptions: InitClientOptions & InitClientRegion<AnalyticsRegion> = {}): AnalyticsClient => {
77+
initAnalytics: (initOptions: InitClientOptions & AnalyticsRegionOptions): AnalyticsClient => {
5378
return analyticsClient(
5479
initOptions.appId || appId,
5580
initOptions.apiKey || apiKey,
@@ -58,24 +83,48 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt
5883
);
5984
},
6085

61-
initAbtesting: (initOptions: InitClientOptions & InitClientRegion<AbtestingRegion> = {}): AbtestingClient => {
62-
return abtestingClient(
86+
initIngestion: (initOptions: InitClientOptions & IngestionRegionOptions): IngestionClient => {
87+
return ingestionClient(
6388
initOptions.appId || appId,
6489
initOptions.apiKey || apiKey,
6590
initOptions.region,
6691
initOptions.options,
6792
);
6893
},
6994

70-
initPersonalization: (
71-
initOptions: InitClientOptions & Required<InitClientRegion<PersonalizationRegion>>,
72-
): PersonalizationClient => {
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 => {
73109
return personalizationClient(
74110
initOptions.appId || appId,
75111
initOptions.apiKey || apiKey,
76112
initOptions.region,
77113
initOptions.options,
78114
);
79115
},
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+
},
80129
};
81130
}
Lines changed: 69 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,47 @@
11
// 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.
22

3-
import type { AbtestingClient, Region as AbtestingRegion } from '@algolia/client-abtesting';
4-
import type { AnalyticsClient, Region as AnalyticsRegion } from '@algolia/client-analytics';
53
import type { ClientOptions } from '@algolia/client-common';
6-
import type { PersonalizationClient, Region as PersonalizationRegion } from '@algolia/client-personalization';
74
import type { SearchClient } from '@algolia/client-search';
8-
import type { RecommendClient } from '@algolia/recommend';
5+
import { searchClient } from '@algolia/client-search';
96

7+
import type { AbtestingClient } from '@algolia/client-abtesting';
108
import { abtestingClient } from '@algolia/client-abtesting';
9+
import type { AnalyticsClient } from '@algolia/client-analytics';
1110
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';
1214
import { personalizationClient } from '@algolia/client-personalization';
13-
import { searchClient } from '@algolia/client-search';
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';
1422
import { recommendClient } from '@algolia/recommend';
1523

16-
import type { InitClientOptions, InitClientRegion } from './models';
24+
import type {
25+
AbtestingRegionOptions,
26+
AnalyticsRegionOptions,
27+
IngestionRegionOptions,
28+
InitClientOptions,
29+
InsightsRegionOptions,
30+
PersonalizationRegionOptions,
31+
QuerySuggestionsRegionOptions,
32+
} from './models';
1733

1834
export * from './models';
1935

2036
export type Algoliasearch = SearchClient & {
21-
initRecommend: (initOptions?: InitClientOptions) => RecommendClient;
22-
initAnalytics: (initOptions?: InitClientOptions & InitClientRegion<AnalyticsRegion>) => AnalyticsClient;
23-
initAbtesting: (initOptions?: InitClientOptions & InitClientRegion<AbtestingRegion>) => AbtestingClient;
24-
initPersonalization: (
25-
initOptions: InitClientOptions & Required<InitClientRegion<PersonalizationRegion>>,
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;
2745
};
2846

2947
export function algoliasearch(appId: string, apiKey: string, options?: ClientOptions): Algoliasearch {
@@ -39,17 +57,24 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt
3957

4058
return {
4159
...client,
60+
4261
/**
4362
* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
4463
*/
4564
get _ua(): string {
4665
return client.transporter.algoliaAgent.value;
4766
},
48-
initRecommend: (initOptions: InitClientOptions = {}): RecommendClient => {
49-
return recommendClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options);
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+
);
5075
},
5176

52-
initAnalytics: (initOptions: InitClientOptions & InitClientRegion<AnalyticsRegion> = {}): AnalyticsClient => {
77+
initAnalytics: (initOptions: InitClientOptions & AnalyticsRegionOptions): AnalyticsClient => {
5378
return analyticsClient(
5479
initOptions.appId || appId,
5580
initOptions.apiKey || apiKey,
@@ -58,24 +83,48 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt
5883
);
5984
},
6085

61-
initAbtesting: (initOptions: InitClientOptions & InitClientRegion<AbtestingRegion> = {}): AbtestingClient => {
62-
return abtestingClient(
86+
initIngestion: (initOptions: InitClientOptions & IngestionRegionOptions): IngestionClient => {
87+
return ingestionClient(
6388
initOptions.appId || appId,
6489
initOptions.apiKey || apiKey,
6590
initOptions.region,
6691
initOptions.options,
6792
);
6893
},
6994

70-
initPersonalization: (
71-
initOptions: InitClientOptions & Required<InitClientRegion<PersonalizationRegion>>,
72-
): PersonalizationClient => {
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 => {
73109
return personalizationClient(
74110
initOptions.appId || appId,
75111
initOptions.apiKey || apiKey,
76112
initOptions.region,
77113
initOptions.options,
78114
);
79115
},
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+
},
80129
};
81130
}

0 commit comments

Comments
 (0)