Skip to content

Commit 12f246e

Browse files
shortcutsshortcuts
authored
chore: use Client suffix (#386)
1 parent 17f44d5 commit 12f246e

Some content is hidden

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

61 files changed

+264
-194
lines changed

‎.github/.cache_version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
8.0.4
1+
8.0.4.3

‎.github/actions/cache/action.yml

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -384,7 +384,7 @@ runs:
384384
key: |
385385
${{ env.CACHE_VERSION }}-${{
386386
hashFiles(
387-
'clients/algoliasearch-client-java-2/api/SearchApi.java',
387+
'clients/algoliasearch-client-java-2/api/SearchClient.java',
388388
'clients/algoliasearch-client-java-2/model/search/**',
389389
'specs/bundled/search.yml',
390390
'templates/java/**',
@@ -399,7 +399,7 @@ runs:
399399
key: |
400400
${{ env.CACHE_VERSION }}-${{
401401
hashFiles(
402-
'clients/algoliasearch-client-java-2/api/RecommendApi.java',
402+
'clients/algoliasearch-client-java-2/api/RecommendClient.java',
403403
'clients/algoliasearch-client-java-2/model/recommend/**',
404404
'specs/bundled/recommend.yml',
405405
'templates/java/**',
@@ -414,7 +414,7 @@ runs:
414414
key: |
415415
${{ env.CACHE_VERSION }}-${{
416416
hashFiles(
417-
'clients/algoliasearch-client-java-2/api/PersonalizationApi.java',
417+
'clients/algoliasearch-client-java-2/api/PersonalizationClient.java',
418418
'clients/algoliasearch-client-java-2/model/personalization/**',
419419
'specs/bundled/personalization.yml',
420420
'templates/java/**',
@@ -429,7 +429,7 @@ runs:
429429
key: |
430430
${{ env.CACHE_VERSION }}-${{
431431
hashFiles(
432-
'clients/algoliasearch-client-java-2/api/AnalyticsApi.java',
432+
'clients/algoliasearch-client-java-2/api/AnalyticsClient.java',
433433
'clients/algoliasearch-client-java-2/model/analytics/**',
434434
'specs/bundled/analytics.yml',
435435
'templates/java/**',
@@ -459,7 +459,7 @@ runs:
459459
key: |
460460
${{ env.CACHE_VERSION }}-${{
461461
hashFiles(
462-
'clients/algoliasearch-client-java-2/api/AbtestingApi.java',
462+
'clients/algoliasearch-client-java-2/api/AbtestingClient.java',
463463
'clients/algoliasearch-client-java-2/model/abtesting/**',
464464
'specs/bundled/abtesting.yml',
465465
'templates/java/**',
@@ -474,7 +474,7 @@ runs:
474474
key: |
475475
${{ env.CACHE_VERSION }}-${{
476476
hashFiles(
477-
'clients/algoliasearch-client-java-2/api/QuerySuggestionsApi.java',
477+
'clients/algoliasearch-client-java-2/api/QuerySuggestionsClient.java',
478478
'clients/algoliasearch-client-java-2/model/querySuggestions/**',
479479
'specs/bundled/query-suggestions.yml',
480480
'templates/java/**',
@@ -489,7 +489,7 @@ runs:
489489
key: |
490490
${{ env.CACHE_VERSION }}-${{
491491
hashFiles(
492-
'clients/algoliasearch-client-java-2/api/PredictApi.java',
492+
'clients/algoliasearch-client-java-2/api/PredictClient.java',
493493
'clients/algoliasearch-client-java-2/model/predict/**',
494494
'specs/bundled/predict.yml',
495495
'templates/java/**',
@@ -502,12 +502,12 @@ runs:
502502
uses: actions/cache@v2
503503
with:
504504
path: |
505-
clients/algoliasearch-client-php/lib/Api/SearchApi.php
505+
clients/algoliasearch-client-php/lib/Api/SearchClient.php
506506
clients/algoliasearch-client-php/lib/Model/Search/**
507507
key: |
508508
${{ env.CACHE_VERSION }}-${{
509509
hashFiles(
510-
'clients/algoliasearch-client-php/lib/Api/SearchApi.php',
510+
'clients/algoliasearch-client-php/lib/Api/SearchClient.php',
511511
'clients/algoliasearch-client-php/lib/Configuration/SearchConfig.php',
512512
'clients/algoliasearch-client-php/lib/Model/Search/**',
513513
'specs/bundled/search.yml',
@@ -520,12 +520,12 @@ runs:
520520
uses: actions/cache@v2
521521
with:
522522
path: |
523-
clients/algoliasearch-client-php/lib/Api/RecommendApi.php
523+
clients/algoliasearch-client-php/lib/Api/RecommendClient.php
524524
clients/algoliasearch-client-php/lib/Model/Recommend/**
525525
key: |
526526
${{ env.CACHE_VERSION }}-${{
527527
hashFiles(
528-
'clients/algoliasearch-client-php/lib/Api/RecommendApi.php',
528+
'clients/algoliasearch-client-php/lib/Api/RecommendClient.php',
529529
'clients/algoliasearch-client-php/lib/Configuration/RecommendConfig.php',
530530
'clients/algoliasearch-client-php/lib/Model/Recommend/**',
531531
'specs/bundled/recommend.yml',
@@ -538,12 +538,12 @@ runs:
538538
uses: actions/cache@v2
539539
with:
540540
path: |
541-
clients/algoliasearch-client-php/lib/Api/PersonalizationApi.php
541+
clients/algoliasearch-client-php/lib/Api/PersonalizationClient.php
542542
clients/algoliasearch-client-php/lib/Model/Personalization/**
543543
key: |
544544
${{ env.CACHE_VERSION }}-${{
545545
hashFiles(
546-
'clients/algoliasearch-client-php/lib/Api/PersonalizationApi.php',
546+
'clients/algoliasearch-client-php/lib/Api/PersonalizationClient.php',
547547
'clients/algoliasearch-client-php/lib/Configuration/PersonalizationConfig.php',
548548
'clients/algoliasearch-client-php/lib/Model/Personalization/**',
549549
'specs/bundled/personalization.yml',
@@ -556,12 +556,12 @@ runs:
556556
uses: actions/cache@v2
557557
with:
558558
path: |
559-
clients/algoliasearch-client-php/lib/Api/AnalyticsApi.php
559+
clients/algoliasearch-client-php/lib/Api/AnalyticsClient.php
560560
clients/algoliasearch-client-php/lib/Model/Analytics/**
561561
key: |
562562
${{ env.CACHE_VERSION }}-${{
563563
hashFiles(
564-
'clients/algoliasearch-client-php/lib/Api/AnalyticsApi.php',
564+
'clients/algoliasearch-client-php/lib/Api/AnalyticsClient.php',
565565
'clients/algoliasearch-client-php/lib/Configuration/AnalyticsConfig.php',
566566
'clients/algoliasearch-client-php/lib/Model/Analytics/**',
567567
'specs/bundled/analytics.yml',
@@ -574,12 +574,12 @@ runs:
574574
uses: actions/cache@v2
575575
with:
576576
path: |
577-
clients/algoliasearch-client-php/lib/Api/InsightsApi.php
577+
clients/algoliasearch-client-php/lib/Api/InsightsClient.php
578578
clients/algoliasearch-client-php/lib/Model/Insights/**
579579
key: |
580580
${{ env.CACHE_VERSION }}-${{
581581
hashFiles(
582-
'clients/algoliasearch-client-php/lib/Api/InsightsApi.php',
582+
'clients/algoliasearch-client-php/lib/Api/InsightsClient.php',
583583
'clients/algoliasearch-client-php/lib/Configuration/InsightsConfig.php',
584584
'clients/algoliasearch-client-php/lib/Model/Insights/**',
585585
'specs/bundled/insights.yml',
@@ -592,12 +592,12 @@ runs:
592592
uses: actions/cache@v2
593593
with:
594594
path: |
595-
clients/algoliasearch-client-php/lib/Api/AbtestingApi.php
595+
clients/algoliasearch-client-php/lib/Api/AbtestingClient.php
596596
clients/algoliasearch-client-php/lib/Model/Abtesting/**
597597
key: |
598598
${{ env.CACHE_VERSION }}-${{
599599
hashFiles(
600-
'clients/algoliasearch-client-php/lib/Api/AbtestingApi.php',
600+
'clients/algoliasearch-client-php/lib/Api/AbtestingClient.php',
601601
'clients/algoliasearch-client-php/lib/Configuration/AbtestingConfig.php',
602602
'clients/algoliasearch-client-php/lib/Model/Abtesting/**',
603603
'specs/bundled/abtesting.yml',
@@ -610,12 +610,12 @@ runs:
610610
uses: actions/cache@v2
611611
with:
612612
path: |
613-
clients/algoliasearch-client-php/lib/Api/QuerySuggestionsApi.php
613+
clients/algoliasearch-client-php/lib/Api/QuerySuggestionsClient.php
614614
clients/algoliasearch-client-php/lib/Model/QuerySuggestions/**
615615
key: |
616616
${{ env.CACHE_VERSION }}-${{
617617
hashFiles(
618-
'clients/algoliasearch-client-php/lib/Api/QuerySuggestionsApi.php',
618+
'clients/algoliasearch-client-php/lib/Api/QuerySuggestionsClient.php',
619619
'clients/algoliasearch-client-php/lib/Configuration/QuerySuggestionsConfig.php',
620620
'clients/algoliasearch-client-php/lib/Model/QuerySuggestions/**',
621621
'specs/bundled/query-suggestions.yml',

‎.github/workflows/check.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -270,14 +270,14 @@ jobs:
270270
uses: actions/cache@v2
271271
with:
272272
path: |
273-
${{ format('{0}/lib/Api/{1}.php', matrix.client.folder, matrix.client.api) }}
274-
${{ format('{0}/lib/Model/{1}/**', matrix.client.folder, matrix.client.capitalizedName) }}
273+
${{ format('{0}/lib/Api/{1}.php', matrix.client.path, matrix.client.api) }}
274+
${{ format('{0}/lib/Model/{1}/**', matrix.client.path, matrix.client.capitalizedName) }}
275275
key: |
276276
${{ env.CACHE_VERSION }}-${{
277277
hashFiles(
278-
format('{0}/lib/Api/{1}.php', matrix.client.folder, matrix.client.api),
279-
format('{0}/lib/Configuration/{1}.php', matrix.client.folder, matrix.client.config),
280-
format('{0}/lib/Model/{1}/**', matrix.client.folder, matrix.client.capitalizedName),
278+
format('{0}/lib/Api/{1}.php', matrix.client.path, matrix.client.api),
279+
format('{0}/lib/Configuration/{1}.php', matrix.client.path, matrix.client.config),
280+
format('{0}/lib/Model/{1}/**', matrix.client.path, matrix.client.capitalizedName),
281281
format('specs/bundled/{0}.yml', matrix.client.name),
282282
'templates/php/**',
283283
'generators/src/**'

‎clients/algoliasearch-client-javascript/packages/algoliasearch/builds/browser.ts

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
import type {
2-
AnalyticsApi,
2+
AnalyticsClient,
33
Region as AnalyticsRegion,
4-
} from '@experimental-api-clients-automation/client-analytics/src/analyticsApi';
5-
import { createAnalyticsApi } from '@experimental-api-clients-automation/client-analytics/src/analyticsApi';
4+
} from '@experimental-api-clients-automation/client-analytics/src/analyticsClient';
5+
import { createAnalyticsClient } from '@experimental-api-clients-automation/client-analytics/src/analyticsClient';
66
import type {
77
CreateClientOptions,
88
Host,
@@ -14,14 +14,14 @@ import {
1414
createBrowserLocalStorageCache,
1515
} from '@experimental-api-clients-automation/client-common';
1616
import type {
17-
PersonalizationApi,
17+
PersonalizationClient,
1818
Region as PersonalizationRegion,
19-
} from '@experimental-api-clients-automation/client-personalization/src/personalizationApi';
20-
import { createPersonalizationApi } from '@experimental-api-clients-automation/client-personalization/src/personalizationApi';
19+
} from '@experimental-api-clients-automation/client-personalization/src/personalizationClient';
20+
import { createPersonalizationClient } from '@experimental-api-clients-automation/client-personalization/src/personalizationClient';
2121
import {
22-
createSearchApi,
22+
createSearchClient,
2323
apiClientVersion,
24-
} from '@experimental-api-clients-automation/client-search/src/searchApi';
24+
} from '@experimental-api-clients-automation/client-search/src/searchClient';
2525
import { createXhrRequester } from '@experimental-api-clients-automation/requester-browser-xhr';
2626

2727
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
@@ -63,8 +63,8 @@ export function algoliasearch(
6363
analyticsApiKey: string,
6464
region?: AnalyticsRegion,
6565
analyticsOptions?: { requester?: Requester; hosts?: Host[] }
66-
): AnalyticsApi {
67-
return createAnalyticsApi({
66+
): AnalyticsClient {
67+
return createAnalyticsClient({
6868
appId: analyticsAppId,
6969
apiKey: analyticsApiKey,
7070
region,
@@ -78,12 +78,12 @@ export function algoliasearch(
7878
personalizationApiKey: string,
7979
region: PersonalizationRegion,
8080
personalizationOptions?: { requester?: Requester; hosts?: Host[] }
81-
): PersonalizationApi {
81+
): PersonalizationClient {
8282
if (!region) {
8383
throw new Error('`region` is missing.');
8484
}
8585

86-
return createPersonalizationApi({
86+
return createPersonalizationClient({
8787
appId: personalizationAppId,
8888
apiKey: personalizationApiKey,
8989
region,
@@ -93,7 +93,7 @@ export function algoliasearch(
9393
}
9494

9595
return {
96-
...createSearchApi({ appId, apiKey, ...commonOptions }),
96+
...createSearchClient({ appId, apiKey, ...commonOptions }),
9797
initAnalytics,
9898
initPersonalization,
9999
};

‎clients/algoliasearch-client-javascript/packages/algoliasearch/builds/node.ts

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
import type {
2-
AnalyticsApi,
2+
AnalyticsClient,
33
Region as AnalyticsRegion,
4-
} from '@experimental-api-clients-automation/client-analytics/src/analyticsApi';
5-
import { createAnalyticsApi } from '@experimental-api-clients-automation/client-analytics/src/analyticsApi';
4+
} from '@experimental-api-clients-automation/client-analytics/src/analyticsClient';
5+
import { createAnalyticsClient } from '@experimental-api-clients-automation/client-analytics/src/analyticsClient';
66
import type {
77
CreateClientOptions,
88
Host,
@@ -13,11 +13,11 @@ import {
1313
createNullCache,
1414
} from '@experimental-api-clients-automation/client-common';
1515
import type {
16-
PersonalizationApi,
16+
PersonalizationClient,
1717
Region as PersonalizationRegion,
18-
} from '@experimental-api-clients-automation/client-personalization/src/personalizationApi';
19-
import { createPersonalizationApi } from '@experimental-api-clients-automation/client-personalization/src/personalizationApi';
20-
import { createSearchApi } from '@experimental-api-clients-automation/client-search/src/searchApi';
18+
} from '@experimental-api-clients-automation/client-personalization/src/personalizationClient';
19+
import { createPersonalizationClient } from '@experimental-api-clients-automation/client-personalization/src/personalizationClient';
20+
import { createSearchClient } from '@experimental-api-clients-automation/client-search/src/searchClient';
2121
import { createHttpRequester } from '@experimental-api-clients-automation/requester-node-http';
2222

2323
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
@@ -53,8 +53,8 @@ export function algoliasearch(
5353
analyticsApiKey: string,
5454
region?: AnalyticsRegion,
5555
analyticsOptions?: { requester?: Requester; hosts?: Host[] }
56-
): AnalyticsApi {
57-
return createAnalyticsApi({
56+
): AnalyticsClient {
57+
return createAnalyticsClient({
5858
appId: analyticsAppId,
5959
apiKey: analyticsApiKey,
6060
region,
@@ -68,12 +68,12 @@ export function algoliasearch(
6868
personalizationApiKey: string,
6969
region: PersonalizationRegion,
7070
personalizationOptions?: { requester?: Requester; hosts?: Host[] }
71-
): PersonalizationApi {
71+
): PersonalizationClient {
7272
if (!region) {
7373
throw new Error('`region` is missing.');
7474
}
7575

76-
return createPersonalizationApi({
76+
return createPersonalizationClient({
7777
appId: personalizationAppId,
7878
apiKey: personalizationApiKey,
7979
region,
@@ -83,7 +83,7 @@ export function algoliasearch(
8383
}
8484

8585
return {
86-
...createSearchApi({ appId, apiKey, ...commonOptions }),
86+
...createSearchClient({ appId, apiKey, ...commonOptions }),
8787
initAnalytics,
8888
initPersonalization,
8989
};

‎config/clients.config.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
"folder": "clients/algoliasearch-client-java-2",
44
"mainPackage": "java-search",
55
"modelFolder": "algoliasearch-core/com/algolia/model",
6+
"apiFolder": "algoliasearch-core/com/algolia/api",
67
"customGenerator": "algolia-java",
78
"tests": {
89
"extension": ".test.java",
@@ -13,6 +14,7 @@
1314
"folder": "clients/algoliasearch-client-javascript",
1415
"mainPackage": "javascript-search",
1516
"modelFolder": "model",
17+
"apiFolder": "src",
1618
"customGenerator": "algolia-javascript",
1719
"tests": {
1820
"extension": ".test.ts",
@@ -23,6 +25,7 @@
2325
"folder": "clients/algoliasearch-client-php",
2426
"mainPackage": "php-search",
2527
"modelFolder": "lib/Model",
28+
"apiFolder": "lib/Api",
2629
"customGenerator": "algolia-php"
2730
}
2831
}

‎generators/src/main/java/com/algolia/codegen/AlgoliaJavaGenerator.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,9 @@ public void processOpts() {
227227
// generator specific options
228228
setDateLibrary("java8");
229229
setSourceFolder("algoliasearch-core");
230+
setApiNameSuffix(Utils.API_SUFFIX);
230231

232+
additionalProperties.put("apiNameSuffix", Utils.API_SUFFIX);
231233
additionalProperties.put("java8", true);
232234
additionalProperties.put("sourceFolder", "algoliasearch-core");
233235

0 commit comments

Comments
 (0)