chore: use Client suffix (#386)

algolia · Apr 20, 2022 · 12f246e · 12f246e
1 parent 17f44d5
commit 12f246e
Show file tree

Hide file tree

Showing 61 changed files with 264 additions and 194 deletions.
diff --git a/.github/.cache_version b/.github/.cache_version
@@ -1 +1 @@
-8.0.4
+8.0.4.3
diff --git a/.github/actions/cache/action.yml b/.github/actions/cache/action.yml
@@ -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/**',
@@ -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/**',
@@ -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/**',
@@ -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/**',
@@ -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/**',
@@ -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/**',
@@ -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/**',
@@ -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',
@@ -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',
@@ -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',
@@ -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',
@@ -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',
@@ -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',
@@ -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',

diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml
@@ -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/**'

diff --git a/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/browser.ts b/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/browser.ts
@@ -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,
@@ -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
@@ -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,
@@ -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,
@@ -93,7 +93,7 @@ export function algoliasearch(
   }
 
   return {
-    ...createSearchApi({ appId, apiKey, ...commonOptions }),
+    ...createSearchClient({ appId, apiKey, ...commonOptions }),
     initAnalytics,
     initPersonalization,
   };

diff --git a/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/node.ts b/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/node.ts
@@ -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,
@@ -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
@@ -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,
@@ -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,
@@ -83,7 +83,7 @@ export function algoliasearch(
   }
 
   return {
-    ...createSearchApi({ appId, apiKey, ...commonOptions }),
+    ...createSearchClient({ appId, apiKey, ...commonOptions }),
     initAnalytics,
     initPersonalization,
   };

diff --git a/config/clients.config.json b/config/clients.config.json
@@ -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",
@@ -13,6 +14,7 @@
     "folder": "clients/algoliasearch-client-javascript",
     "mainPackage": "javascript-search",
     "modelFolder": "model",
+    "apiFolder": "src",
     "customGenerator": "algolia-javascript",
     "tests": {
       "extension": ".test.ts",
@@ -23,6 +25,7 @@
     "folder": "clients/algoliasearch-client-php",
     "mainPackage": "php-search",
     "modelFolder": "lib/Model",
+    "apiFolder": "lib/Api",
     "customGenerator": "algolia-php"
   }
 }
diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaJavaGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaJavaGenerator.java
@@ -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");