Skip to content

chore: use Client suffix #386

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Apr 20, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/.cache_version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
8.0.4
8.0.4.3
42 changes: 21 additions & 21 deletions .github/actions/cache/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ runs:
key: |
${{ env.CACHE_VERSION }}-${{
hashFiles(
'clients/algoliasearch-client-java-2/api/SearchApi.java',
'clients/algoliasearch-client-java-2/api/SearchClient.java',
'clients/algoliasearch-client-java-2/model/search/**',
'specs/bundled/search.yml',
'templates/java/**',
Expand All @@ -399,7 +399,7 @@ runs:
key: |
${{ env.CACHE_VERSION }}-${{
hashFiles(
'clients/algoliasearch-client-java-2/api/RecommendApi.java',
'clients/algoliasearch-client-java-2/api/RecommendClient.java',
'clients/algoliasearch-client-java-2/model/recommend/**',
'specs/bundled/recommend.yml',
'templates/java/**',
Expand All @@ -414,7 +414,7 @@ runs:
key: |
${{ env.CACHE_VERSION }}-${{
hashFiles(
'clients/algoliasearch-client-java-2/api/PersonalizationApi.java',
'clients/algoliasearch-client-java-2/api/PersonalizationClient.java',
'clients/algoliasearch-client-java-2/model/personalization/**',
'specs/bundled/personalization.yml',
'templates/java/**',
Expand All @@ -429,7 +429,7 @@ runs:
key: |
${{ env.CACHE_VERSION }}-${{
hashFiles(
'clients/algoliasearch-client-java-2/api/AnalyticsApi.java',
'clients/algoliasearch-client-java-2/api/AnalyticsClient.java',
'clients/algoliasearch-client-java-2/model/analytics/**',
'specs/bundled/analytics.yml',
'templates/java/**',
Expand Down Expand Up @@ -459,7 +459,7 @@ runs:
key: |
${{ env.CACHE_VERSION }}-${{
hashFiles(
'clients/algoliasearch-client-java-2/api/AbtestingApi.java',
'clients/algoliasearch-client-java-2/api/AbtestingClient.java',
'clients/algoliasearch-client-java-2/model/abtesting/**',
'specs/bundled/abtesting.yml',
'templates/java/**',
Expand All @@ -474,7 +474,7 @@ runs:
key: |
${{ env.CACHE_VERSION }}-${{
hashFiles(
'clients/algoliasearch-client-java-2/api/QuerySuggestionsApi.java',
'clients/algoliasearch-client-java-2/api/QuerySuggestionsClient.java',
'clients/algoliasearch-client-java-2/model/querySuggestions/**',
'specs/bundled/query-suggestions.yml',
'templates/java/**',
Expand All @@ -489,7 +489,7 @@ runs:
key: |
${{ env.CACHE_VERSION }}-${{
hashFiles(
'clients/algoliasearch-client-java-2/api/PredictApi.java',
'clients/algoliasearch-client-java-2/api/PredictClient.java',
'clients/algoliasearch-client-java-2/model/predict/**',
'specs/bundled/predict.yml',
'templates/java/**',
Expand All @@ -502,12 +502,12 @@ runs:
uses: actions/cache@v2
with:
path: |
clients/algoliasearch-client-php/lib/Api/SearchApi.php
clients/algoliasearch-client-php/lib/Api/SearchClient.php
clients/algoliasearch-client-php/lib/Model/Search/**
key: |
${{ env.CACHE_VERSION }}-${{
hashFiles(
'clients/algoliasearch-client-php/lib/Api/SearchApi.php',
'clients/algoliasearch-client-php/lib/Api/SearchClient.php',
'clients/algoliasearch-client-php/lib/Configuration/SearchConfig.php',
'clients/algoliasearch-client-php/lib/Model/Search/**',
'specs/bundled/search.yml',
Expand All @@ -520,12 +520,12 @@ runs:
uses: actions/cache@v2
with:
path: |
clients/algoliasearch-client-php/lib/Api/RecommendApi.php
clients/algoliasearch-client-php/lib/Api/RecommendClient.php
clients/algoliasearch-client-php/lib/Model/Recommend/**
key: |
${{ env.CACHE_VERSION }}-${{
hashFiles(
'clients/algoliasearch-client-php/lib/Api/RecommendApi.php',
'clients/algoliasearch-client-php/lib/Api/RecommendClient.php',
'clients/algoliasearch-client-php/lib/Configuration/RecommendConfig.php',
'clients/algoliasearch-client-php/lib/Model/Recommend/**',
'specs/bundled/recommend.yml',
Expand All @@ -538,12 +538,12 @@ runs:
uses: actions/cache@v2
with:
path: |
clients/algoliasearch-client-php/lib/Api/PersonalizationApi.php
clients/algoliasearch-client-php/lib/Api/PersonalizationClient.php
clients/algoliasearch-client-php/lib/Model/Personalization/**
key: |
${{ env.CACHE_VERSION }}-${{
hashFiles(
'clients/algoliasearch-client-php/lib/Api/PersonalizationApi.php',
'clients/algoliasearch-client-php/lib/Api/PersonalizationClient.php',
'clients/algoliasearch-client-php/lib/Configuration/PersonalizationConfig.php',
'clients/algoliasearch-client-php/lib/Model/Personalization/**',
'specs/bundled/personalization.yml',
Expand All @@ -556,12 +556,12 @@ runs:
uses: actions/cache@v2
with:
path: |
clients/algoliasearch-client-php/lib/Api/AnalyticsApi.php
clients/algoliasearch-client-php/lib/Api/AnalyticsClient.php
clients/algoliasearch-client-php/lib/Model/Analytics/**
key: |
${{ env.CACHE_VERSION }}-${{
hashFiles(
'clients/algoliasearch-client-php/lib/Api/AnalyticsApi.php',
'clients/algoliasearch-client-php/lib/Api/AnalyticsClient.php',
'clients/algoliasearch-client-php/lib/Configuration/AnalyticsConfig.php',
'clients/algoliasearch-client-php/lib/Model/Analytics/**',
'specs/bundled/analytics.yml',
Expand All @@ -574,12 +574,12 @@ runs:
uses: actions/cache@v2
with:
path: |
clients/algoliasearch-client-php/lib/Api/InsightsApi.php
clients/algoliasearch-client-php/lib/Api/InsightsClient.php
clients/algoliasearch-client-php/lib/Model/Insights/**
key: |
${{ env.CACHE_VERSION }}-${{
hashFiles(
'clients/algoliasearch-client-php/lib/Api/InsightsApi.php',
'clients/algoliasearch-client-php/lib/Api/InsightsClient.php',
'clients/algoliasearch-client-php/lib/Configuration/InsightsConfig.php',
'clients/algoliasearch-client-php/lib/Model/Insights/**',
'specs/bundled/insights.yml',
Expand All @@ -592,12 +592,12 @@ runs:
uses: actions/cache@v2
with:
path: |
clients/algoliasearch-client-php/lib/Api/AbtestingApi.php
clients/algoliasearch-client-php/lib/Api/AbtestingClient.php
clients/algoliasearch-client-php/lib/Model/Abtesting/**
key: |
${{ env.CACHE_VERSION }}-${{
hashFiles(
'clients/algoliasearch-client-php/lib/Api/AbtestingApi.php',
'clients/algoliasearch-client-php/lib/Api/AbtestingClient.php',
'clients/algoliasearch-client-php/lib/Configuration/AbtestingConfig.php',
'clients/algoliasearch-client-php/lib/Model/Abtesting/**',
'specs/bundled/abtesting.yml',
Expand All @@ -610,12 +610,12 @@ runs:
uses: actions/cache@v2
with:
path: |
clients/algoliasearch-client-php/lib/Api/QuerySuggestionsApi.php
clients/algoliasearch-client-php/lib/Api/QuerySuggestionsClient.php
clients/algoliasearch-client-php/lib/Model/QuerySuggestions/**
key: |
${{ env.CACHE_VERSION }}-${{
hashFiles(
'clients/algoliasearch-client-php/lib/Api/QuerySuggestionsApi.php',
'clients/algoliasearch-client-php/lib/Api/QuerySuggestionsClient.php',
'clients/algoliasearch-client-php/lib/Configuration/QuerySuggestionsConfig.php',
'clients/algoliasearch-client-php/lib/Model/QuerySuggestions/**',
'specs/bundled/query-suggestions.yml',
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -270,14 +270,14 @@ jobs:
uses: actions/cache@v2
with:
path: |
${{ format('{0}/lib/Api/{1}.php', matrix.client.folder, matrix.client.api) }}
${{ format('{0}/lib/Model/{1}/**', matrix.client.folder, matrix.client.capitalizedName) }}
${{ format('{0}/lib/Api/{1}.php', matrix.client.path, matrix.client.api) }}
${{ format('{0}/lib/Model/{1}/**', matrix.client.path, matrix.client.capitalizedName) }}
key: |
${{ env.CACHE_VERSION }}-${{
hashFiles(
format('{0}/lib/Api/{1}.php', matrix.client.folder, matrix.client.api),
format('{0}/lib/Configuration/{1}.php', matrix.client.folder, matrix.client.config),
format('{0}/lib/Model/{1}/**', matrix.client.folder, matrix.client.capitalizedName),
format('{0}/lib/Api/{1}.php', matrix.client.path, matrix.client.api),
format('{0}/lib/Configuration/{1}.php', matrix.client.path, matrix.client.config),
format('{0}/lib/Model/{1}/**', matrix.client.path, matrix.client.capitalizedName),
format('specs/bundled/{0}.yml', matrix.client.name),
'templates/php/**',
'generators/src/**'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import type {
AnalyticsApi,
AnalyticsClient,
Region as AnalyticsRegion,
} from '@experimental-api-clients-automation/client-analytics/src/analyticsApi';
import { createAnalyticsApi } from '@experimental-api-clients-automation/client-analytics/src/analyticsApi';
} from '@experimental-api-clients-automation/client-analytics/src/analyticsClient';
import { createAnalyticsClient } from '@experimental-api-clients-automation/client-analytics/src/analyticsClient';
import type {
CreateClientOptions,
Host,
Expand All @@ -14,14 +14,14 @@ import {
createBrowserLocalStorageCache,
} from '@experimental-api-clients-automation/client-common';
import type {
PersonalizationApi,
PersonalizationClient,
Region as PersonalizationRegion,
} from '@experimental-api-clients-automation/client-personalization/src/personalizationApi';
import { createPersonalizationApi } from '@experimental-api-clients-automation/client-personalization/src/personalizationApi';
} from '@experimental-api-clients-automation/client-personalization/src/personalizationClient';
import { createPersonalizationClient } from '@experimental-api-clients-automation/client-personalization/src/personalizationClient';
import {
createSearchApi,
createSearchClient,
apiClientVersion,
} from '@experimental-api-clients-automation/client-search/src/searchApi';
} from '@experimental-api-clients-automation/client-search/src/searchClient';
import { createXhrRequester } from '@experimental-api-clients-automation/requester-browser-xhr';

// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
Expand Down Expand Up @@ -63,8 +63,8 @@ export function algoliasearch(
analyticsApiKey: string,
region?: AnalyticsRegion,
analyticsOptions?: { requester?: Requester; hosts?: Host[] }
): AnalyticsApi {
return createAnalyticsApi({
): AnalyticsClient {
return createAnalyticsClient({
appId: analyticsAppId,
apiKey: analyticsApiKey,
region,
Expand All @@ -78,12 +78,12 @@ export function algoliasearch(
personalizationApiKey: string,
region: PersonalizationRegion,
personalizationOptions?: { requester?: Requester; hosts?: Host[] }
): PersonalizationApi {
): PersonalizationClient {
if (!region) {
throw new Error('`region` is missing.');
}

return createPersonalizationApi({
return createPersonalizationClient({
appId: personalizationAppId,
apiKey: personalizationApiKey,
region,
Expand All @@ -93,7 +93,7 @@ export function algoliasearch(
}

return {
...createSearchApi({ appId, apiKey, ...commonOptions }),
...createSearchClient({ appId, apiKey, ...commonOptions }),
initAnalytics,
initPersonalization,
};
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import type {
AnalyticsApi,
AnalyticsClient,
Region as AnalyticsRegion,
} from '@experimental-api-clients-automation/client-analytics/src/analyticsApi';
import { createAnalyticsApi } from '@experimental-api-clients-automation/client-analytics/src/analyticsApi';
} from '@experimental-api-clients-automation/client-analytics/src/analyticsClient';
import { createAnalyticsClient } from '@experimental-api-clients-automation/client-analytics/src/analyticsClient';
import type {
CreateClientOptions,
Host,
Expand All @@ -13,11 +13,11 @@ import {
createNullCache,
} from '@experimental-api-clients-automation/client-common';
import type {
PersonalizationApi,
PersonalizationClient,
Region as PersonalizationRegion,
} from '@experimental-api-clients-automation/client-personalization/src/personalizationApi';
import { createPersonalizationApi } from '@experimental-api-clients-automation/client-personalization/src/personalizationApi';
import { createSearchApi } from '@experimental-api-clients-automation/client-search/src/searchApi';
} from '@experimental-api-clients-automation/client-personalization/src/personalizationClient';
import { createPersonalizationClient } from '@experimental-api-clients-automation/client-personalization/src/personalizationClient';
import { createSearchClient } from '@experimental-api-clients-automation/client-search/src/searchClient';
import { createHttpRequester } from '@experimental-api-clients-automation/requester-node-http';

// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
Expand Down Expand Up @@ -53,8 +53,8 @@ export function algoliasearch(
analyticsApiKey: string,
region?: AnalyticsRegion,
analyticsOptions?: { requester?: Requester; hosts?: Host[] }
): AnalyticsApi {
return createAnalyticsApi({
): AnalyticsClient {
return createAnalyticsClient({
appId: analyticsAppId,
apiKey: analyticsApiKey,
region,
Expand All @@ -68,12 +68,12 @@ export function algoliasearch(
personalizationApiKey: string,
region: PersonalizationRegion,
personalizationOptions?: { requester?: Requester; hosts?: Host[] }
): PersonalizationApi {
): PersonalizationClient {
if (!region) {
throw new Error('`region` is missing.');
}

return createPersonalizationApi({
return createPersonalizationClient({
appId: personalizationAppId,
apiKey: personalizationApiKey,
region,
Expand All @@ -83,7 +83,7 @@ export function algoliasearch(
}

return {
...createSearchApi({ appId, apiKey, ...commonOptions }),
...createSearchClient({ appId, apiKey, ...commonOptions }),
initAnalytics,
initPersonalization,
};
Expand Down
3 changes: 3 additions & 0 deletions config/clients.config.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"folder": "clients/algoliasearch-client-java-2",
"mainPackage": "java-search",
"modelFolder": "algoliasearch-core/com/algolia/model",
"apiFolder": "algoliasearch-core/com/algolia/api",
"customGenerator": "algolia-java",
"tests": {
"extension": ".test.java",
Expand All @@ -13,6 +14,7 @@
"folder": "clients/algoliasearch-client-javascript",
"mainPackage": "javascript-search",
"modelFolder": "model",
"apiFolder": "src",
"customGenerator": "algolia-javascript",
"tests": {
"extension": ".test.ts",
Expand All @@ -23,6 +25,7 @@
"folder": "clients/algoliasearch-client-php",
"mainPackage": "php-search",
"modelFolder": "lib/Model",
"apiFolder": "lib/Api",
"customGenerator": "algolia-php"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,9 @@ public void processOpts() {
// generator specific options
setDateLibrary("java8");
setSourceFolder("algoliasearch-core");
setApiNameSuffix(Utils.API_SUFFIX);

additionalProperties.put("apiNameSuffix", Utils.API_SUFFIX);
additionalProperties.put("java8", true);
additionalProperties.put("sourceFolder", "algoliasearch-core");

Expand Down
Loading